418 telegram verification

[Behzad-rabiei]

Summary by CodeRabbit

Release Notes

• New Features

  • Added a new endpoint for generating Telegram verification tokens.
  • Introduced Telegram as a supported platform in the platform creation request.
  • Added a new constant for verification token parameters.

• Bug Fixes

  • Improved consistency in API documentation response codes.

• Documentation

  • Updated OpenAPI documentation for authentication and platform endpoints.

• Chores

  • Updated dependency version for @togethercrew.dev/db.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces Telegram verification token generation functionality to the authentication system. The changes span multiple files, adding a new endpoint for generating tokens, updating validation schemas, and extending the token service. The modifications include adding a new route, creating a token generation method, updating API documentation, and introducing Telegram-specific validation for platform creation.

Changes

File	Change Summary
package.json	Updated @togethercrew.dev/db package version from ^3.0.72 to ^3.0.78
src/config/telegram.ts	Added verificationToken constant with verificationCodeLength and allowedCharacters
src/controllers/auth.controller.ts	Added generateToken function for creating Telegram verification tokens
src/docs/auth.doc.yml	Added new /generate-token endpoint documentation, updated response formatting
src/docs/platform.doc.yml	Added "telegram" to platform creation options, included Telegram metadata requirements
src/routes/v1/auth.route.ts	Added new POST /generate-token route with authentication and validation
src/services/token.service.ts	Added generateRandomCode and generateTelegramVerificationToken functions
src/validations/auth.validation.ts	Added generateToken validation schema
src/validations/platform.validation.ts	Added Telegram metadata validation for platform creation

Sequence Diagram

sequenceDiagram
    participant Client
    participant AuthController
    participant TokenService
    participant Database

    Client->>AuthController: POST /generate-token
    AuthController->>TokenService: generateTelegramVerificationToken(userId, communityId)
    TokenService->>TokenService: generateRandomCode()
    TokenService->>Database: saveToken()
    Database-->>TokenService: Token saved
    TokenService-->>AuthController: Token generated
    AuthController-->>Client: Return token details

Loading

Possibly related PRs

• 353 notion platform + notion settings for hivemind #354: Updates @togethercrew.dev/db package version similarly
• 357 mediawiki platform + mediawiki settings for hivemind + enums for names #358: Updates @togethercrew.dev/db package version
• Improvments and fix bugs #360: Continues package version update trend

Poem

🐰 A Rabbit's Token Tale 🔑

In Telegram's digital domain,
A verification token I'll explain,
With crypto's might and random flair,
Generating codes with rabbit's care!
Security dances, tokens take flight! 🚀

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

---

📜 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 260940f and 31b3e46.

⛔ Files ignored due to path filters (1)

• package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (9)

• package.json (1 hunks)
• src/config/telegram.ts (1 hunks)
• src/controllers/auth.controller.ts (1 hunks)
• src/docs/auth.doc.yml (4 hunks)
• src/docs/platform.doc.yml (2 hunks)
• src/routes/v1/auth.route.ts (1 hunks)
• src/services/token.service.ts (4 hunks)
• src/validations/auth.validation.ts (2 hunks)
• src/validations/platform.validation.ts (2 hunks)

---

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>, 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. (Beta)
• @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.