feat: Add email template for inviting user to workspace

[Allan2000-Git]

User description

Description

This PR adds an email template for inviting user to project. It provides users with key information regarding the project name
project joining URL, invited by, invited on and invitation role.

Fixes #54

Dependencies

No new dependencies introduced.

Future Improvements

N/A

Mentions

@rajdip-b

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.

---

PR Type

enhancement

---

Description

• Added a new userInvitation method to the IMailService interface, allowing for user invitations via email.
• Implemented the userInvitation method in MailService, which sends an HTML formatted email containing project invitation details and a call-to-action button.
• Created a mock version of the userInvitation method in MockMailService for testing, which logs the invitation details.

---

Changes walkthrough 📝

	Relevant files
Enhancement	interface.service.ts Add user invitation method to mail service interface          apps/api/src/mail/services/interface.service.ts Added userInvitation method to the IMailService interface. Method includes parameters for email, project details, inviter, and role. +9/-0      mail.service.ts Implement user invitation email with HTML template              apps/api/src/mail/services/mail.service.ts Implemented userInvitation method in MailService. Constructed HTML email template for project invitation. Included project details and call-to-action button in the email. +184/-0
Tests	mock.service.ts Add mock user invitation method for testing                            apps/api/src/mail/services/mock.service.ts Added mock implementation of userInvitation method. Logs invitation details for testing purposes. +13/-0

---

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

[codiumai-pr-agent-free]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Code Duplication The HTML email template in the userInvitation method contains a lot of inline CSS. Consider extracting this into a separate CSS file or using a CSS-in-JS solution to improve maintainability. Hardcoded URLs The email template contains hardcoded URLs for privacy policy and terms and conditions. Consider making these configurable or storing them in environment variables.

[codiumai-pr-agent-free]

PR Code Suggestions ✨

No code suggestions found for the PR.

[rajdip-b]

Hey man, that's some impressive work. Although again, the scope of this issue is outdated. So it would be Workspace, not project. And gladly, we already have a function for workspace. All you would need is to update the stylings of that mail template.

Additionally, I would like to take a call from @kriptonian1 @darksaiii about the design decisions.

[kriptonian1]

@Allan2000-Git I like the work, but can you do the implementation in React email, they have better support for all email client and also have accessibility for clients which doesn't support HTML.

[Allan2000-Git]

@rajdip-b Will rename project to workspace.
@kriptonian1 I guess all the templates are written in plain HTML & CSS in mail.service.ts. Should I change everyone of them or just keep the scope for the current PR?

[kriptonian1]

@rajdip-b Will rename project to workspace. @kriptonian1 I guess all the templates are written in plain HTML & CSS in mail.service.ts. Should I change everyone of them or just keep the scope for the current PR?

@rajdip-b should we make a new issue for this

[rajdip-b]

A new PR would be really great. I don't think we need a new issue for that, adding hacktoberfest-accepted to the PR should be enough.

[kriptonian1]

A new PR would be really great. I don't think we need a new issue for that, adding hacktoberfest-accepted to the PR should be enough.

Yes, as per as I know, they just count the PR with hacktoberfest-accepted tag

[rajdip-b]

Hey man, that's some impressive work. Although again, the scope of this issue is outdated. So it would be Workspace, not project. And gladly, we already have a function for workspace. All you would need is to update the stylings of that mail template.

Additionally, I would like to take a call from @kriptonian1 @darksaiii about the design decisions.

@Allan2000-Git if you can implement these changes, I will be happy to merge.

[Allan2000-Git]

Hey man, that's some impressive work. Although again, the scope of this issue is outdated. So it would be Workspace, not project. And gladly, we already have a function for workspace. All you would need is to update the stylings of that mail template.
Additionally, I would like to take a call from @kriptonian1 @darksaiii about the design decisions.

@Allan2000-Git if you can implement these changes, I will be happy to merge.

@rajdip-b Since the template has to be designed using react-email, it's bit difficult since I'm not able to preview the code. So would need help there.

[rajdip-b]

@kriptonian1 can you please help him out?

[kriptonian1]

Hey man, that's some impressive work. Although again, the scope of this issue is outdated. So it would be Workspace, not project. And gladly, we already have a function for workspace. All you would need is to update the stylings of that mail template.
Additionally, I would like to take a call from @kriptonian1 @darksaiii about the design decisions.

@Allan2000-Git if you can implement these changes, I will be happy to merge.

@rajdip-b Since the template has to be designed using react-email, it's bit difficult since I'm not able to preview the code. So would need help there.

React email has preview, I'll recommend you to go through the docs and watch some tutorials on YouTube before diving into it.

Here is a video you can refer to

https://youtu.be/pHXHBHdTzrM?si=BAg-r_EYyJmfhK2W

[rajdip-b]

@Allan2000-Git hey buddy, any updates on this?

[Allan2000-Git]

@rajdip-b There's already a PR with react email usage. Since most the things are failing, so I didn't go ahead with the same here.

[Allan2000-Git]

Template is ready and is working fine

[Allan2000-Git]

Can you pull the changes from this PR and check. Would be of great help