feat: create user endpoint

[Sachinsharma01]

User description

Description

Adding an endpoint that is accessible to Admins only that let, Admin to create a user.
Give a summary of the change that you have made

Fixes #[ISSUENO]
#13

Dependencies

Mention any dependencies/packages used
NO

Future Improvements

Mention any improvements to be done in future related to any file/feature

Mentions

Mention and tag the people

Screenshots of relevant screens

Add screenshots of relevant screens

Developer's checklist

• My PR follows the style guidelines of this project
• I have performed a self-check on my work

If changes are made in the code:

• I have followed the coding guidelines
• My changes in code generate no new warnings
• My changes are breaking another fix/feature of the project
• I have added test cases to show that my feature works
• I have added relevant screenshots in my PR
• There are no UI/UX issues

Documentation Update

• This PR requires an update to the documentation at docs.keyshade.xyz
• I have made the necessary updates to the documentation, or no documentation changes are required.

---

Type

Enhancement

---

Description

This PR introduces a new feature that allows admins to create new users. The main changes include:

• Addition of a new accountLoginEmail method to the IMailService interface and its implementation in the MailService and MockMailService classes.
• Creation of a new data transfer object ICrateUserDTO for user creation.
• Addition of a new createUser method to the UserController class, which is guarded by the AdminGuard.
• Addition of a new createUserByAdmin method to the IUserRepository interface and its implementation in the UserRepository and MockUserRepository classes.
• Addition of a new createUser method to the UserService class, which checks for duplicate users and sends a login email to the newly created user.

---

Changes walkthrough

Relevant files

Enhancement

9 files interface.service.ts                                                                                apps/api/src/mail/services/interface.service.ts Added a new method accountLoginEmail to the IMailService interface. +4/-0 mail.service.ts                                                                                          apps/api/src/mail/services/mail.service.ts Implemented the accountLoginEmail method in the MailService class. +22/-0 mock.service.ts                                                                                          apps/api/src/mail/services/mock.service.ts Implemented the accountLoginEmail method in the MockMailService class. +4/-0 user.controller.ts                                                                                    apps/api/src/user/controller/user.controller.ts Added a new createUser method to the UserController class, which is guarded by the AdminGuard. +8/-0 create.user.ts                                                                                            apps/api/src/user/dto/create.user/create.user.ts Created a new data transfer object ICrateUserDTO for user creation. +16/-0 interface.repository.ts                                                                          apps/api/src/user/repository/interface.repository.ts Added a new method createUserByAdmin to the IUserRepository interface. +7/-0 mock.repository.ts                                                                                    apps/api/src/user/repository/mock.repository.ts Implemented the createUserByAdmin method in the MockUserRepository class. +8/-0 user.repository.ts                                                                                    apps/api/src/user/repository/user.repository.ts Implemented the createUserByAdmin method in the UserRepository class. +9/-0 user.service.ts                                                                                          apps/api/src/user/service/user.service.ts Added a new createUser method to the UserService class, which checks for duplicate users and sends a login email to the newly created user. +30/-2

---

✨ Usage guide:

---

Overview:
The describe tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

When commenting, to edit configurations related to the describe tool (pr_description section), use the following template:

/describe --pr_description.some_config1=... --pr_description.some_config2=...

With a configuration file, use the following template:

[pr_description]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode for the describe tool is: pr_commands = ["/describe --pr_description.add_original_user_description=true" "--pr_description.keep_original_user_title=true", ...] meaning the describe tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description. Markers are an alternative way to control the generated description, to give maximal control to the user. If you set: pr_commands = ["/describe --pr_description.use_description_markers=true", ...] the tool will replace every marker of the form pr_agent:marker_name in the PR description with the relevant content, where marker_name is one of the following: type: the PR type. summary: the PR summary. walkthrough: the PR walkthrough. Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.

Custom labels The default labels of the describe tool are quite generic: [Bug fix, Tests, Enhancement, Documentation, Other]. If you specify custom labels in the repo's labels page or via configuration file, you can get tailored labels for your use cases. Examples for custom labels: Main topic:performance - pr_agent:The main topic of this PR is performance New endpoint - pr_agent:A new endpoint was added in this PR SQL query - pr_agent:A new SQL query was added in this PR Dockerfile changes - pr_agent:The PR contains changes in the Dockerfile ... The list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases. Note that Labels are not mutually exclusive, so you can add multiple label categories. Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.

More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the describe usage page for a comprehensive guide on using this tool.

[codiumai-pr-agent-free]

PR Description updated to latest commit (c56ce3c)

[codiumai-pr-agent-free]

PR Analysis

• 🎯 Main theme: Adding an endpoint for admins to create a new user
• 📝 PR summary: This PR introduces a new feature that allows admins to create new users. It includes the addition of a new method to the IMailService interface, creation of a new data transfer object ICrateUserDTO, and the implementation of these in the MailService, MockMailService classes, and user services and controllers.
• 📌 Type of PR: Enhancement
• 🧪 Relevant tests added: No
• ⏱️ Estimated effort to review [1-5]: 3, because the PR introduces new features and modifies several files, but the changes are straightforward and follow good coding practices.
• 🔒 Security concerns: No

PR Feedback

💡 General suggestions: The PR is well-structured and the code changes are clear. However, it would be beneficial to include unit tests for the new features to ensure they work as expected. Also, consider handling potential exceptions that could be thrown when creating a new user or sending an email.

🤖 Code feedback:

---

relevant file	apps/api/src/user/service/user.service.ts
suggestion	Consider adding error handling for potential exceptions thrown by this.repository.createUserByAdmin(user) and this.resendService.accountLoginEmail(newUser.email). This could help prevent the application from crashing and provide a more meaningful error message to the user. [important]
relevant line	const newUser = await this.repository.createUserByAdmin(user)

---

relevant file	apps/api/src/user/controller/user.controller.ts
suggestion	It would be good to validate the dto: ICrateUserDTO object before passing it to the createUser method. This can help catch any invalid or missing fields early and provide a more descriptive error message to the user. [medium]
relevant line	async createUser(@Body() dto: ICrateUserDTO) {

---

---

✨ Usage guide:

---

Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

Utilizing extra instructions The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize. Examples for extra instructions: [pr_reviewer] # /review # extra_instructions=""" In the code feedback section, emphasize the following: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

How to enable\disable automation When you first install PR-Agent app, the default mode for the review tool is: pr_commands = ["/review", ...] meaning the review tool will run automatically on every PR, with the default configuration. Edit this field to enable/disable the tool, or to change the used configurations

About the 'Code feedback' section The review tool provides several type of feedbacks, one of them is code suggestions. If you are interested only in the code suggestions, it is recommended to use the improve feature instead, since it dedicated only to code suggestions, and usually gives better results. Use the review tool if you want to get a more comprehensive feedback, which includes code suggestions as well.

Auto-labels The review tool can auto-generate two specific types of labels for a PR: a possible security issue label, that detects possible security issues (enable_review_labels_security flag) a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)

Extra sub-tools The review tool provides a collection of possible feedbacks about a PR. It is recommended to review the possible options, and choose the ones relevant for your use case. Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: require_score_review, require_soc2_review, enable_review_labels_effort, and more.

More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the review usage page for a comprehensive guide on using this tool.

[rajdip-b]

@Sachinsharma01 thanks man! I will surely review this tomorrow morning!

[rajdip-b]

Also, make sure you run pnpm run test:api before you push the changes since some tests are failing

[rajdip-b]

Seems that there are some merge conflicts. No worries, I'll resolve them myself and merge this when I can!

[rajdip-b]

🎉 This PR is included in version 1.0.0-alpha.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

[rajdip-b]

🎉 This PR is included in version 1.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀