search

kinde-oss / management-api-js

javascript package for interacting with the Kinde Management API
https://www.kinde.com
MIT License
6 stars 5 forks source link

feat: added checkAudience and validateToken methods #3

Closed DanielRivers closed 6 months ago

DanielRivers commented 6 months ago

Explain your changes

Checklist

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

Summary by CodeRabbit

coderabbitai[bot] commented 6 months ago

Walkthrough

The recent updates focus on improving consistency in naming conventions and enhancing security features in the codebase. Key changes include renaming a configuration property, updating import paths, adding new utility functions, and improving token validation logic. Additionally, a new dependency has been introduced to assist with JWT verification, ensuring robust authentication mechanisms.

Changes

File Change Summary
lib/config.ts Updated kinde_domain to kindeDomain and corrected its assignment to process.env.KINDE_DOMAIN.
lib/utilities/getToken.ts Changed import path for hasTokenExpired function.
lib/utilities/index.ts Added checkAudience and validateToken to exports.
.../token/checkAudience.ts Added a check for decoded.aud presence before using includes.
.../token/hasTokenExpired.ts Revised token expiration check logic to compare against current time.
.../token/validateToken.ts Introduced JWT validation using RSA verification.
package.json Added aws-jwt-verify version ^4.0.1.
Recent Review Details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between aaac9bad99a6f85cfdf341ecb273a88e262e5740 and 86583bf166352219cdac233e91fe3efc1aee9ecb.
Files ignored due to path filters (1) * `pnpm-lock.yaml` is excluded by `!pnpm-lock.yaml`
Files selected for processing (7) * lib/config.ts (2 hunks) * lib/utilities/getToken.ts (1 hunks) * lib/utilities/index.ts (1 hunks) * lib/utilities/token/checkAudience.ts (1 hunks) * lib/utilities/token/hasTokenExpired.ts (1 hunks) * lib/utilities/token/validateToken.ts (1 hunks) * package.json (1 hunks)
Additional comments not posted (7)
lib/utilities/index.ts (2)
`4-5`: Imports for `checkAudience` and `validateToken` are correctly added. Ensure these modules are properly implemented. --- `7-7`: Export statement correctly includes the new functions. Ensure that all dependent modules update their imports accordingly.
lib/utilities/token/hasTokenExpired.ts (1)
`12-12`: The updated expiration check logic is correct and aligns with standard practices for JWT expiration handling.
lib/utilities/token/checkAudience.ts (1)
`18-18`: The addition of a safe navigation operator (`?.`) before calling `includes` on `decoded.aud` is a good practice to prevent runtime errors.
package.json (1)
`32-32`: The addition of `aws-jwt-verify` at version `^4.0.1` is appropriate for JWT verification functionality. Ensure compatibility with other project dependencies.
lib/config.ts (1)
`10-23`: > :memo: **NOTE** > This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [13-33] The update to use `kindeDomain` and its assignment from an environment variable enhances configuration consistency and security by not hardcoding sensitive information.
lib/utilities/getToken.ts (1)
`7-7`: Correct update of the import statement for `hasTokenExpired`. This change ensures that the correct module is used for token expiration checks.
--- 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.` 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. - 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.