add unverifiedTelegramUsername to user schema

[Behzad-rabiei]

Summary by CodeRabbit

• New Features

  • Introduced a new field for users to add their unverified Telegram username, enhancing the user profile options.

• Documentation

  • Updated software version to 3.0.33 in documentation to reflect the latest changes.

[coderabbitai]

Walkthrough

The project introduced a new field unverifiedTelegramUsername to the user-related entities and tests, enhancing user profiles with additional social media handles. This update signifies a minor version increment, reflecting the addition without breaking changes or major new features.

Changes

File Path	Change Summary
README.md, src/interfaces/User.interface.ts, src/models/schemas/User.schema.ts	Added unverifiedTelegramUsername field to user-related interfaces and schema.
__tests__/unit/models/user.model.test.ts	Included unverifiedTelegramUsername in user object creation for tests.
package.json	Version updated from "3.0.32" to "3.0.33".

🐰✨
In fields of code, where changes bloom,
A new field grows, 'neath the moon's soft gloom.
With each small hop, a version new,
A rabbit's touch, in lines so few.
"alex_jane", now whispers through,
A tale of updates, fresh and true.
🌟🐾

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.

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 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/coderabbit-overrides.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

Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 57c2b31 and d8869ed.

Files selected for processing (5)

• README.md (1 hunks)
• tests/unit/models/user.model.test.ts (1 hunks)
• package.json (1 hunks)
• src/interfaces/User.interface.ts (1 hunks)
• src/models/schemas/User.schema.ts (1 hunks)

Files skipped from review due to trivial changes (1)

• package.json

Additional comments not posted (5)

src/interfaces/User.interface.ts (2)

9-9: Ensure the unverifiedTelegramUsername field is consistently used across all relevant interfaces and implementations.

---

16-16: Ensure the unverifiedTelegramUsername field in IUserUpdateBody aligns with its definition in the IUser interface for consistency.

src/models/schemas/User.schema.ts (1)

27-29: The addition of unverifiedTelegramUsername to the User schema is correctly implemented. Ensure the application logic correctly handles this field as optional.

__tests__/unit/models/user.model.test.ts (1)

17-17: The addition of unverifiedTelegramUsername with a sample value in the test setup is good practice. Ensure comprehensive test coverage for this new field, including both positive and negative cases.

README.md (1)

47-47: The documentation update to include unverifiedTelegramUsername in the User interface is well done. Keeping documentation updated is crucial for clarity and usability.

[coderabbitai]

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between d8869ed and 08c668c.

Files selected for processing (2)

• tests/unit/models/user.model.test.ts (1 hunks)
• src/models/schemas/User.schema.ts (1 hunks)

Files skipped from review as they are similar to previous changes (2)

• tests/unit/models/user.model.test.ts
• src/models/schemas/User.schema.ts