feat: KINDE_SCOPE + getUser upgrades

[peterphanouvong]

Explain your changes

• enable users to configure scope with KINDE_SCOPE in .env
• getUser now returns phone and username
  Suppose there is a related issue with enough detail for a reviewer to understand your changes fully. In that case, you can omit an explanation and instead include either “Fixes #XX” or “Updates #XX” where “XX” is the issue number.

Checklist

• I have read the “Pull requests” section in the contributing guidelines.
• I agree to the terms within the code of conduct.

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

[coderabbitai]

Walkthrough

The recent changes enhance the configuration and user data retrieval capabilities of the project. A new scope property has been introduced into various configuration classes to dynamically set authentication scopes. The getUserFactory function now fetches additional user data (phone_number and username), enhancing user profile completeness.

Changes

File Path	Change Summary
src/config/index.js	Added scope property to config, defaulting to 'openid profile email offline', and set framework.
src/routerClients/AppRouterClient.js	Updated AppRouterClient constructor to include a new scope property in the options parameter.
src/routerClients/PagesRouterClient.js	Added scope property to the options parameter in the constructor, enhancing configuration flexibility.
src/session/getUser.js	getUserFactory function now fetches phone_number and username using kindeClient.getClaimValue.
types.d.ts	Added optional username and phone_number fields to the KindeUser type.

---

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
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 105f4d3 and 2062a57.

Files selected for processing (5)

• src/config/index.js (3 hunks)
• src/routerClients/AppRouterClient.js (2 hunks)
• src/routerClients/PagesRouterClient.js (1 hunks)
• src/session/getUser.js (1 hunks)
• types.d.ts (1 hunks)

Files skipped from review due to trivial changes (1)

• types.d.ts

Additional comments not posted (7)

src/session/getUser.js (3)

23-27: Ensure correct token type for phone_number claim.

The phone_number claim is fetched using the id_token. Verify if this is the correct token type.

---

28-32: Ensure correct token type for username claim.

The username claim is fetched using the id_token. Verify if this is the correct token type.

---

35-36: LGTM!

The changes to include phone_number and username in the user object look good.

src/routerClients/PagesRouterClient.js (1)

12-12: LGTM!

The addition of the scope property to the clientConfig looks good.

src/routerClients/AppRouterClient.js (1)

14-14: LGTM!

The addition of the scope property to the clientConfig looks good.

src/config/index.js (2)

57-57: LGTM!

The addition of the scope property with a default value looks good.

---

94-95: LGTM!

The addition of the framework property looks good.