fix: add explicit schema for token payload

[joshunrau]

Inferring the type is impossible due to a known issue not planned to be fixed in TypeScript. This solution adds more boilerplate, but makes sure that library consumers don't access non-existent properties during the authentication process.

Summary by CodeRabbit

• New Features

  • Introduced a streamlined authentication framework that clearly separates user credentials from token-related data, offering enhanced validation and flexibility.

• Refactor

  • Consolidated and reorganized authentication configuration settings for improved maintainability.
  • Simplified integration by refining what is exposed for use, ensuring a more robust and consistent authentication experience.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes refactor the authentication module’s configuration and types. The single loginCredentialsSchema is replaced with a schemas object containing distinct loginCredentials and tokenPayload schemas. Several exported types have been removed or updated, and the type definitions in tests and configuration files now include more generic parameters to enhance type safety. The AuthModule’s constructor and static methods have been updated accordingly to accommodate these schema changes.

Changes

File(s)	Change Summary
example/app.ts src/modules/auth/__tests__/auth.module.spec.ts	Restructured schema definitions by removing the standalone loginCredentialsSchema and introducing a schemas object containing loginCredentials and a new tokenPayload schema (with variations in properties across files).
src/index.ts src/modules/auth/auth.config.ts	Updated exported types: Removed exports for UserQuery and UserQueryResult, and modified type definitions to use new generic parameters for token payload handling.
src/modules/auth/auth.module.ts	Modified the AuthModule’s configuration by updating the constructor and static methods (forRoot and forRootAsync) to destructure schemas and use TPayloadSchema, and removed obsolete imports.

Sequence Diagram(s)

sequenceDiagram
    participant App as Application
    participant Auth as AuthModule
    participant Prov as Config Provider

    App->>Auth: Call forRoot/forRootAsync(options with schemas)
    Auth->>Prov: Retrieve configuration (loginCredentials & tokenPayload)
    Prov-->>Auth: Return validated schemas
    Auth-->>App: Return configured DynamicModule

Loading

Poem

Hoppin' through the code with cheer,
Schemas reformed, now crystal clear.
Login and token, a duo so bright,
Types refined through day and night.
With every change, my heart does flap —
A joyful hop, straight from my rabbit gap!
🐰✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 62987d6 and 1bc1aeb.

📒 Files selected for processing (5)

• example/app.ts (1 hunks)
• src/index.ts (1 hunks)
• src/modules/auth/__tests__/auth.module.spec.ts (2 hunks)
• src/modules/auth/auth.config.ts (2 hunks)
• src/modules/auth/auth.module.ts (2 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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 generate docstrings to generate docstrings for this 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

[github-actions]

🎉 This PR is included in version 2.0.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀