feat: TS enhancements

[DanielRivers]

Explain your changes

• SessionManager now accepts an optional generic to type when getting and setting the session.
• Added interface for AuthUrlParams

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.

Summary by CodeRabbit

• New Features
  • Enhanced OAuth2 flow by allowing additional parameters such as language preference, login hints, and connection IDs for a more tailored authentication experience.
• Refactor
  • Improved type safety and clarity in session management with the introduction of generics for session item handling.

[coderabbitai]

Warning

Rate Limit Exceeded

@DanielRivers has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 13 minutes and 44 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 882696d and 8260be4.

Walkthrough

The recent updates introduce enhancements to OAuth2 flow configurations and session management in the SDK. Specifically, the changes aim to provide developers with more control and clarity in managing authentication flows and session data.

Changes

File(s)	Change Summary
lib/sdk/oauth2-flows/types.ts	Updated AuthURLOptions to use AuthURLParams for authUrlParams, adding parameters like lang, login_hint, and connection_id.
lib/sdk/session-managers/types.ts	Enhanced SessionManager methods with generics <T = unknown> for improved type safety and clarity in handling session items.
lib/sdk/oauth2-flows/AuthCodeAbstract.ts	Refactored AuthCodeAbstract class to change searchParamsObject type and handle options.authUrlParams more efficiently. Added conditional extraction of specific properties like lang, login_hint, and connection_id. Included a loop to convert values to strings before appending them to searchParams.

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-tests 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 tests 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 tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 52e5bba and 0220045.

Files selected for processing (2)

• lib/sdk/oauth2-flows/types.ts (1 hunks)
• lib/sdk/session-managers/types.ts (1 hunks)

Additional comments: 4

lib/sdk/session-managers/types.ts (2)

• 9-9: The addition of a generic type <T = unknown> for the getSessionItem method enhances type safety by allowing developers to specify the expected return type. This is a significant improvement for type clarity and reducing potential type-related errors.
• 10-10: Similarly, the introduction of a generic type <T = unknown> for the setSessionItem method improves type safety by enabling developers to specify the type of the item being set. This change aligns well with the objective of enhancing type safety and clarity in session management.

lib/sdk/oauth2-flows/types.ts (2)

• 56-61: The introduction of the AuthURLParams interface is a positive change, providing a structured and type-safe way to handle authentication URL parameters. This allows for the inclusion of additional parameters such as lang, login_hint, and connection_id, enhancing flexibility and control over the authentication process. The use of an index signature [key: string]: string | undefined; further adds to the flexibility by allowing for arbitrary string parameters.
• 70-70: Updating the AuthURLOptions interface to include the authUrlParams property of type AuthURLParams aligns with the objective of improving type safety and clarity in handling authentication URL parameters. This change effectively leverages the newly introduced AuthURLParams interface, contributing to a more robust and flexible codebase.

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 0220045 and 882696d.

Files selected for processing (1)

• lib/sdk/oauth2-flows/AuthCodeAbstract.ts (2 hunks)

Additional comments: 2

lib/sdk/oauth2-flows/AuthCodeAbstract.ts (2)

• 249-249: The change from Record<string, string> to Record<string, unknown> for searchParamsObject increases the flexibility of the values that can be stored. However, it's important to ensure that the values are properly validated or sanitized before use, especially since they are being converted to strings and appended to URL search parameters. This change could potentially introduce security concerns if not handled carefully.
• 267-280: Refactoring to destructure specific properties (lang, login_hint, and connection_id) from options.authUrlParams and assigning the rest to rest is a clean way to handle optional parameters. This approach enhances readability and maintainability of the code. However, ensure that the destructured properties are used as intended and that there's no loss of functionality or unintended behavior change due to this refactoring.