kinde-oss / kinde-auth-nextjs

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

feat: adding refreshData #180

Closed DanielRivers closed 2 weeks ago

DanielRivers commented 2 weeks ago

Explain your changes

Adds ability for browser to refresh the claim data.

Checklist

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

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The recent updates focus on enhancing data handling across various modules by introducing and refactoring a refreshData function. This includes changes in configurations, updates in the React-based AuthProvider component for state management, and modifications to the Kinde Browser Client to utilize the new refreshData function. The version number has also been incremented to reflect these functional enhancements.

Changes

File Change Summary
src/config/index.js Added refreshData function to initialState object. Updated export declarations to include refreshData.
src/frontend/AuthProvider.jsx Reordered imports, added refreshData function, moved state initialization within KindeProvider, and adjusted flag handling logic.
src/frontend/KindeBrowserClient.js Refactored fetchData function into refreshData and updated useEffect hook to call refreshData.
src/utils/version.js Updated version number from '2.2.13' to '2.3.0-3'.
types.d.ts Added refreshData method to KindeClient and KindeState types, supporting asynchronous data refresh.

Sequence Diagrams

Old Flow vs New Flow in KindeBrowserClient

Old Flow

sequenceDiagram
    actor User
    participant KindeBrowserClient
    User ->> KindeBrowserClient: Initiates component
    KindeBrowserClient ->> KindeBrowserClient: useEffect() hook
    KindeBrowserClient ->> KindeBrowserClient: fetchData()
    KindeBrowserClient -->> User: Fetch data completed

New Flow

sequenceDiagram
    actor User
    participant KindeBrowserClient
    User ->> KindeBrowserClient: Initiates component
    KindeBrowserClient ->> KindeBrowserClient: useEffect() hook
    KindeBrowserClient ->> KindeBrowserClient: refreshData()
    KindeBrowserClient -->> User: Refresh data completed

KindeProvider Data Handling

sequenceDiagram
    participant KindeProvider
    participant KindeBrowserClient
    KindeProvider ->> KindeBrowserClient: refreshData()
    KindeBrowserClient -->> KindeProvider: Data refreshed
    KindeProvider ->> KindeProvider: Update state with new data

These diagrams showcase the improved flow with refreshData replacing fetchData, leading to a more streamlined and separated data handling logic.


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 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](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.