Add options to getToken always force refresh

[DaveOrDead]

Explain your changes

The forceRefresh option will always call the Kinde token endpoint to get the latest version of the tokens

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 updates introduce a new GetTokenOptions parameter to the getTokenType function in src/createKindeClient.ts, and modify the getToken and getIdToken functions to utilize this parameter. This enhancement allows for additional options during token retrieval, specifically the option to force a token refresh. The GetTokenOptions type, which includes an optional isForceRefresh boolean property, has been added to src/types.ts to support this functionality.

Changes

File	Change Summary
src/createKindeClient.ts	Added GetTokenOptions parameter to getTokenType, getToken, and getIdToken functions.
src/types.ts	Introduced GetTokenOptions type with an optional isForceRefresh boolean property.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant Client
    participant KindeClient
    participant AuthServer

    Client->>KindeClient: getToken(options: GetTokenOptions)
    alt isForceRefresh is true
        KindeClient->>AuthServer: Request new token
        AuthServer-->>KindeClient: Return new token
    else isForceRefresh is false or undefined
        KindeClient->>KindeClient: Retrieve cached token
    end
    KindeClient-->>Client: Return token

Loading

sequenceDiagram
    participant Client
    participant KindeClient
    participant AuthServer

    Client->>KindeClient: getIdToken(options: GetTokenOptions)
    alt isForceRefresh is true
        KindeClient->>AuthServer: Request new ID token
        AuthServer-->>KindeClient: Return new ID token
    else isForceRefresh is false or undefined
        KindeClient->>KindeClient: Retrieve cached ID token
    end
    KindeClient-->>Client: Return ID token

Loading

---

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

Outside diff range and nitpick comments (1)

src/createKindeClient.ts (1)

Line range hint 369-374: Optimize array iteration method.

The use of forEach for iterating over arrays can be less efficient than other methods like for...of, especially with large arrays or when combined with other array operations. Consider refactoring to use for...of for better performance.

- audience.trim().split(/\s+/).forEach((aud) => {
-   urlSearchParams.append('audience', aud);
- });
+ for (const aud of audience.trim().split(/\s+/)) {
+   urlSearchParams.append('audience', aud);
+ }

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 560ffd3 and c440f91.

Files selected for processing (2)

• src/createKindeClient.ts (3 hunks)
• src/types.ts (1 hunks)

Files skipped from review due to trivial changes (1)

• src/types.ts

Additional context used

Biome

src/createKindeClient.ts

[error] 369-374: Prefer for...of instead of forEach. (lint/complexity/noForEach)

forEach may lead to performance issues when working with large arrays. When combined with functions like filter or map, this causes multiple iterations over the same type.

Additional comments not posted (2)

src/createKindeClient.ts (2)

199-202: Ensure correct handling of isForceRefresh option in getTokenType.

The implementation of the isForceRefresh option in the getTokenType function correctly forces a token refresh when the option is set. This aligns with the PR's objective to allow forced token refreshes.

Also applies to: 205-205

---

221-221: Validate the integration of GetTokenOptions in getToken and getIdToken.

The integration of the GetTokenOptions parameter in the getToken and getIdToken functions is correctly implemented. This allows these functions to utilize the new forceRefresh functionality.

Also applies to: 225-225