feat: Add email template for inviting user to workspace #480

Allan2000-Git · 2024-10-06T17:41:55Z

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 · 2024-10-06T17:42:18Z

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 · 2024-10-06T17:43:37Z

PR Code Suggestions ✨

No code suggestions found for the PR.

rajdip-b · 2024-10-07T04:58:27Z

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 · 2024-10-07T05:50:54Z

@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 · 2024-10-07T07:06:30Z

@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 · 2024-10-07T08:50:19Z

@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 · 2024-10-08T07:24:22Z

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 · 2024-10-12T20:41:37Z

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 · 2024-10-13T11:16:19Z

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 · 2024-10-13T11:31:49Z

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 · 2024-10-13T12:03:05Z

@kriptonian1 can you please help him out?

kriptonian1 · 2024-10-13T16:04:53Z

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 · 2024-11-02T11:34:52Z

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

Allan2000-Git · 2024-11-02T11:42:55Z

@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 · 2024-11-02T11:43:48Z

Template is ready and is working fine

Allan2000-Git · 2024-11-02T11:44:26Z

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

…nto feat/user-invitation-email-template

apps/api/src/mail/services/interface.service.ts

apps/api/src/mail/services/mail.service.ts

… mail service

apps/api/src/mail/services/interface.service.ts

apps/api/src/mail/emails/workspace-invitation.tsx

…com/Allan2000-Git/keyshade into feat/user-invitation-email-template

…e-xyz#480) Co-authored-by: Rajdip Bhattacharya <[email protected]>

## [2.9.0](v2.8.0...v2.9.0) (2025-01-23) ### 🚀 Features * **api-client:** Get all workspace invitation ([#619](#619)) ([8a23850](8a23850)) * **api,cli,api-client,schema:** Enhance permissions to allow filtering by environments through project roles ([#599](#599)) ([030b539](030b539)) * **api:** Add `ADMIN` authority for API keys ([#609](#609)) ([fb6aba7](fb6aba7)) * **api:** Add email template for inviting user to workspace ([#480](#480)) ([f5ddf7a](f5ddf7a)) * **api:** Add email template for sending OTP to the user ([#582](#582)) ([cb6bbcb](cb6bbcb)) * **api:** Add endpoint to fetch all workspace invitations for a user ([#586](#586)) ([d45417a](d45417a)) * **api:** Add logout endpoint to clear token cookie ([#581](#581)) ([27f81ba](27f81ba)) * **api:** Add slack integration ([#531](#531)) ([fe124d8](fe124d8)) * **cli:** Add CLI command to check version flag using `--version` or `-v` ([#650](#650)) ([31b5efe](31b5efe)) * **cli:** Add functionality to operate on Workspace Membership ([#589](#589)) ([0fde62b](0fde62b)) * **cli:** Add import sub commmand for project. ([#594](#594)) ([9896f27](9896f27)) * **cli:** Add List-invitation command ([#633](#633)) ([874f8c2](874f8c2)) * **cli:** Added keyshade command to cli ([cf260ae](cf260ae)) * **cli:** Api health probe ([#645](#645)) ([dd854f4](dd854f4)) * **cli:** Create basic README.md ([a1b74e9](a1b74e9)) * **cli:** Log publicKey, privacyKey, & accessLevel after project creation ([#623](#623)) ([5d5b329](5d5b329)) * **cli:** Supports to specify environment(s) and its optional description ([#634](#634)) ([62083b1](62083b1)) * **cli:** update README with feature and installation ([#644](#644)) ([a4d2a6a](a4d2a6a)) * **platform:** Add a new [secure] and added loader on project screen ([#603](#603)) ([c3a08cc](c3a08cc)) * **platform:** Add new variables to a project ([#593](#593)) ([d6c6252](d6c6252)) * **platform:** Delete variable from a project ([#600](#600)) ([e64a738](e64a738)) * **platform:** Edit existing variables in a project ([#602](#602)) ([bb48f6c](bb48f6c)) * **platform:** Show all the existing variables inside a project ([#591](#591)) ([5276bb8](5276bb8)) * **platofrm:** Added online/offline status detection in the platform ([#585](#585)) ([89aa84f](89aa84f)) * **schema:** Add workspace invitation schema ([#612](#612)) ([1a5721b](1a5721b)) * **web:** Add Google Analytics integration ([#649](#649)) ([397d6da](397d6da)) ### 🐛 Bug Fixes * **api:** Empty name `""` accepted as a valid name while creating environments ([#583](#583)) ([a33f4b5](a33f4b5)) * **api:** Enable global project access ([#580](#580)) ([b3a0309](b3a0309)) * **api:** Update build command ([0ddfa59](0ddfa59)) * **cli:** Add keywords for improved package discoverability ([#641](#641)) ([57ce10b](57ce10b)) * **cli:** Check for .keyshade dir if profile isn't found ([#636](#636)) ([a69665d](a69665d)) * **cli:** Create project --store-private-key option default value removed ([#638](#638)) ([20f16c6](20f16c6)) * **cli:** Fixed binary path in package.json ([e531af0](e531af0)) * **cli:** Fixed binary path in package.json ([81d674d](81d674d)) * **cli:** Incorrect message on listing projects ([#624](#624)) ([eeffa42](eeffa42)) * **cli:** Module errors ([d3432c5](d3432c5)) * **cli:** Module errors ([a639065](a639065)) * **cli:** Module errors ([a7742b1](a7742b1)) * **cli:** Module errors ([e96300e](e96300e)) * **cli:** Profile name now can use - and _ and updated error message ([#639](#639)) ([00dd66a](00dd66a)) * **cli:** Prompt users for all values if no option set and show default values ([#640](#640)) ([fe862ab](fe862ab)) * **docker:** Update build script ([40ef3e2](40ef3e2)) * **platform:** Check if `Env. Name` is left empty ([#646](#646)) ([5f3fac8](5f3fac8)) * **platform:** Clickable Workspaces combobox options ([#630](#630)) ([acc96f7](acc96f7)) * **platform:** Optimized user update request body ([#605](#605)) ([ee1adf0](ee1adf0)) * **platform:** Type error in navbar ([8199de8](8199de8)) * **README:** Update Discord badge ([6f9382e](6f9382e)) * **schema:** Add versions field to project [secure]s and variables response ([#590](#590)) ([755ea46](755ea46)) ### 📚 Documentation * **cli:** Update changelog to include missed out changes ([8910c5c](8910c5c)) * Updated alignment of pictures in API Testing page ([5d69223](5d69223)) * Updated alignment of pictures in API Testing page ([e31eeca](e31eeca)) ### 🔧 Miscellaneous Chores * Add Sentry and update CI ([#653](#653)) ([ca96862](ca96862)) * **ci:** Add CLI deployment script ([51de9d1](51de9d1)) * **ci:** Add internal package dependencies to existing workflows ([#592](#592)) ([a9fc39e](a9fc39e)) * **ci:** Add scope ([8ef89a8](8ef89a8)) * **ci:** Bug fix in workflow ([d583a46](d583a46)) * **ci:** Bug fix in workflow ([eb9d60f](eb9d60f)) * **ci:** Bump version to 2.2.0 ([951bd14](951bd14)) * **ci:** Deploy DB migrations ([ea1beed](ea1beed)) * **ci:** Fixed chaining and scripts ([6a009eb](6a009eb)) * **ci:** Fixed environment name ([172c348](172c348)) * **ci:** Fixed errors ([f28e3b5](f28e3b5)) * **ci:** Minor fixes ([c7f05a0](c7f05a0)) * **ci:** Push docker images of platform and API to ACR ([5f79dd7](5f79dd7)) * **ci:** Remove npm ci ([3d45a4c](3d45a4c)) * **ci:** Remove pnpm cache ([f45970c](f45970c)) * **ci:** Update app redeployment ([18cf765](18cf765)) * **ci:** Update web deployment to push to ACR ([26d4bed](26d4bed)) * **cli:** Bumped CLI to v2.4.0 ([09efcd9](09efcd9)) * **cli:** Rearranged dependency ([b6e344d](b6e344d)) * **cli:** Removed changeset ([6c436de](6c436de)) * **cli:** Update package name ([23552a1](23552a1)) * **cli:** Update package name ([480cf54](480cf54)) * **cli:** Update package.json ([871679a](871679a)) * **cli:** Updated build scripts ([2e2b42d](2e2b42d)) * **docker:** Update port of platform docker build ([c79d886](c79d886)) * Housekeeping ([2ed31c0](2ed31c0)) * **platoform:** Swapped all legacy API calls with `@keyshade/api-client` ([#584](#584)) ([c600db7](c600db7)) * Removed .postman folder ([4b2b675](4b2b675)) * Reverted back registry ([1699a89](1699a89)) * **schema:** Add describe blocks in tests for each kind of schema ([#577](#577)) ([c0763f3](c0763f3)) * Update npmrc ([9f7f495](9f7f495)) * Update pipelines; fixed api docker ([3f36a17](3f36a17)) * Update platform build command ([83a1851](83a1851)) * **web:** Fix CI ([d1bc740](d1bc740)) * **web:** Update dockerfile and ci to include google analytics env ([f2df4f4](f2df4f4)) ### 🔨 Code Refactoring * **cli:** Replace arguments with options ([#615](#615)) ([498f44e](498f44e)) * **platform:** Optimized codebase ([#629](#629)) ([d411081](d411081)) * **platform:** Refactor project components ([#626](#626)) ([5b70805](5b70805)) * **web:** Changed the text in the hero section of the web application ([#579](#579)) ([a92925f](a92925f))

rajdip-b · 2025-01-23T15:07:13Z

🎉 This PR is included in version 2.9.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Allan2000-Git requested a review from rajdip-b as a code owner October 6, 2024 17:41

codiumai-pr-agent-free bot added enhancement Review effort [1-5]: 2 labels Oct 6, 2024

feat: add user invitation email template

92ff06e

rajdip-b force-pushed the feat/user-invitation-email-template branch from 90b8aed to 92ff06e Compare October 13, 2024 11:15

rajdip-b changed the title ~~feat: Add email template for inviting user to project~~ feat: Add email template for inviting user to workspace Oct 13, 2024

rajdip-b added the hacktoberfest-accepted Your PR has this = Congrats! label Oct 13, 2024

Allan2000-Git added 2 commits December 3, 2024 21:17

Merge branch 'develop' of https://github.com/Allan2000-Git/keyshade i…

45931c5

…nto feat/user-invitation-email-template

Merge branch 'develop' into feat/user-invitation-email-template

a6d7e9b

rajdip-b requested changes Dec 3, 2024

View reviewed changes

apps/api/src/mail/services/interface.service.ts Outdated Show resolved Hide resolved

Merge branch 'develop' into feat/user-invitation-email-template

043a6b7

rajdip-b requested changes Dec 3, 2024

View reviewed changes

apps/api/src/mail/services/mail.service.ts Outdated Show resolved Hide resolved

Allan2000-Git and others added 2 commits December 5, 2024 21:48

feat: implemented workspace invitation email template & corresponding…

5541754

… mail service

Merge branch 'develop' into feat/user-invitation-email-template

703939d

rajdip-b requested changes Dec 6, 2024

View reviewed changes

apps/api/src/mail/services/interface.service.ts Outdated Show resolved Hide resolved

apps/api/src/mail/emails/workspace-invitation.tsx Outdated Show resolved Hide resolved

Allan2000-Git added 4 commits December 6, 2024 21:05

fix: renamed projectName to workspaceName & projectUrl to actionUrl

80238ee

Merge branch 'feat/user-invitation-email-template' of https://github.…

6ac034d

…com/Allan2000-Git/keyshade into feat/user-invitation-email-template

feat: created a reusable base email template component

f609d29

fix: replaced term project with workspace

a2d79d7

rajdip-b approved these changes Dec 7, 2024

View reviewed changes

Merge branch 'develop' into feat/user-invitation-email-template

83c959d

rajdip-b merged commit f5ddf7a into keyshade-xyz:develop Dec 7, 2024
4 checks passed

rajdip-b mentioned this pull request Dec 12, 2024

Mail template for inviting non-registered users #55

Closed

muntaxir4 pushed a commit to muntaxir4/keyshade that referenced this pull request Jan 1, 2025

feat(api): Add email template for inviting user to workspace (keyshad…

f83b952

…e-xyz#480) Co-authored-by: Rajdip Bhattacharya <[email protected]>

rajdip-b added the released on @develop label Jan 23, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add email template for inviting user to workspace #480

feat: Add email template for inviting user to workspace #480

Allan2000-Git commented Oct 6, 2024 •

edited

Loading

codiumai-pr-agent-free bot commented Oct 6, 2024

codiumai-pr-agent-free bot commented Oct 6, 2024

rajdip-b commented Oct 7, 2024

kriptonian1 commented Oct 7, 2024

Allan2000-Git commented Oct 7, 2024

kriptonian1 commented Oct 7, 2024

rajdip-b commented Oct 8, 2024

kriptonian1 commented Oct 12, 2024

rajdip-b commented Oct 13, 2024

Allan2000-Git commented Oct 13, 2024

rajdip-b commented Oct 13, 2024

kriptonian1 commented Oct 13, 2024

rajdip-b commented Nov 2, 2024

Allan2000-Git commented Nov 2, 2024 •

edited

Loading

Allan2000-Git commented Nov 2, 2024

Allan2000-Git commented Nov 2, 2024

rajdip-b commented Jan 23, 2025

feat: Add email template for inviting user to workspace #480

feat: Add email template for inviting user to workspace #480

Conversation

Allan2000-Git commented Oct 6, 2024 • edited Loading

User description

Description

Dependencies

Future Improvements

Mentions

Screenshots of relevant screens

Developer's checklist

Documentation Update

PR Type

Description

Changes walkthrough 📝

codiumai-pr-agent-free bot commented Oct 6, 2024

PR Reviewer Guide 🔍

codiumai-pr-agent-free bot commented Oct 6, 2024

PR Code Suggestions ✨

rajdip-b commented Oct 7, 2024

kriptonian1 commented Oct 7, 2024

Allan2000-Git commented Oct 7, 2024

kriptonian1 commented Oct 7, 2024

rajdip-b commented Oct 8, 2024

kriptonian1 commented Oct 12, 2024

rajdip-b commented Oct 13, 2024

Allan2000-Git commented Oct 13, 2024

rajdip-b commented Oct 13, 2024

kriptonian1 commented Oct 13, 2024

rajdip-b commented Nov 2, 2024

Allan2000-Git commented Nov 2, 2024 • edited Loading

Allan2000-Git commented Nov 2, 2024

Allan2000-Git commented Nov 2, 2024

rajdip-b commented Jan 23, 2025

Allan2000-Git commented Oct 6, 2024 •

edited

Loading

Allan2000-Git commented Nov 2, 2024 •

edited

Loading