Setup `@comet/mail-react` package #4951

jamesricky · 2025-12-15T10:12:42Z

Description

This will be used for helper functions for building HTML emails with React, such as the already included css helper.
Simple components built with React and/or MJML may also be added in future PRs.

Acceptance criteria

I have verified if my change requires an example
I have verified if my change requires a changeset
I have verified if my change requires screenshots/screencasts

Open TODOs/questions

Add changeset

Further information

Task: https://vivid-planet.atlassian.net/browse/COM-1971

This will be used for helper functions for building HTML emails with React, such as the already included `css` helper. Simple components built with React and/or MJML may also be added in future PRs.

johnnyomair · 2025-12-16T14:37:51Z

What's the difference between this package and the mail-rendering package?

packages/mail/package.json

packages/mail-react/eslint.config.mjs

johnnyomair · 2025-12-16T14:47:49Z

Depending on what you intend to put into this package (is it only utils?) we should decide if we want to reserve the @comet/mail name for future usage (can't think of an example though).

Alternative names:

@comet/mail-utils
@comet/mail-rendering
@comet/mail-helper

johnnyomair · 2025-12-16T14:48:44Z

What's the difference between this package and the mail-rendering package?

Found an internal discussion: the mail-rendering package has peer dependencies on @comet/cms-site and styled-components, which we don't want.

.changeset/mighty-pants-march.md

jamesricky · 2025-12-16T15:03:33Z

What's the difference between this package and the mail-rendering package?

It probably doesn't make sense to have both packages.
"Brevo Module" doesn't seem like the correct place for these things, as they are generic (maybe comet-specific) things that have nothing to do with Brevo.

We discussed this a while ago internally, I sent you the thread 🙂

Another reason was that we don't want/need the dependency on @comet/cms-site.
I'm not sure this point is still relevant though, since we have the separate @comet/site-react package now.

jamesricky · 2025-12-16T15:14:40Z

Depending on what you intend to put into this package (is it only utils?) we should decide if we want to reserve the @comet/mail name for future usage (can't think of an example though).

Utils for now, likely react and/or react-mjml components in the future.
Basically things that help rendering the HTML for mails.

You're right, @comet/mail might be useful for other things in the future, that don't have anything to do with rendering the HTML (like sending-logic in the API or something 🤷🏼)

@comet/mail-rendering might be good 👍🏼

@thomasdax98 what do you think?

jamesricky · 2025-12-16T15:20:02Z

What's the difference between this package and the mail-rendering package?

The mail-rendering package currently only exports a single NewsletterImageBlock component, most of the code seems to be the image logic which is now available in the @comet/site-react package anyway.

johnnyomair · 2025-12-17T12:05:53Z

It probably doesn't make sense to have both packages.

Agree'd. We should merge the @comet/brevo-mail-rendering package into this in the future.

jamesricky · 2025-12-19T09:03:49Z

It probably doesn't make sense to have both packages.

Agree'd. We should merge the @comet/brevo-mail-rendering package into this in the future.

That would probably make sense.

The image-logic seems to have been copied into @comet/brevo-mail-rendering. Therefore we could add @comet/site-react as a (peer-)dependency to the mail package, to avoid this and future code duplication.
Do you think that's a good idea? @johnnyomair

Maybe the name of the package should then be @comet/mail-react? 🤔
(Since it's basically like @comet/site-nextjs but for mails instead of nextjs 😄)

Maybe even an additional @comet/mail-mjml would make sense but I think that's overkill for now.

johnnyomair · 2025-12-22T08:09:03Z

Therefore we could add @comet/site-react as a (peer-)dependency to the mail package, to avoid this and future code duplication.
Do you think that's a good idea? @johnnyomair

I'm not sure about this, since site and mail could evolve into very different directions. Maybe a little copying is okay.

Maybe the name of the package should then be @comet/mail-react? 🤔
(Since it's basically like @comet/site-nextjs but for mails instead of nextjs 😄)

Yes, good idea!

Maybe even an additional @comet/mail-mjml would make sense but I think that's overkill for now.

Agree'd.

johnnyomair · 2025-12-22T14:27:50Z

packages/mail-react/package.json

+    "main": "lib/index.js",
+    "scripts": {
+        "build": "pnpm run clean && tsc",
+        "clean": "rimraf lib",


The rimraf dependency appears to be missing.

johnnyomair · 2025-12-22T14:29:07Z

packages/mail-react/package.json

+    "version": "8.10.0",
+    "description": "Utilities for building HTML emails with React",
+    "type": "commonjs",
+    "main": "lib/index.js",


The package.json should include a types and files field as well, see:

comet/packages/api/cms-api/package.json

Lines 13 to 17 in 47944a7

"types": "lib/index.d.ts",

"files": [

"bin/**/*.js",

"lib/*"

],

.

I added those, but without bin/**/*.js, as there is no bin directory created during build.
Is that correct? (I have no idea what this is used for 😅)

johnnyomair · 2025-12-22T14:29:36Z

packages/mail-react/package.json

+    "peerDependencies": {
+        "eslint": ">=9",
+        "prettier": ">=3"
+    },


This aren't peer dependencies. Which package did you choose as basis?

Sorry, should have noticed that, they are included in devDependencies anyway 😅

Which package did you choose as basis?

Mostly from site-react but partially from eslint-config because I thought that would be the smallest/simplest.

johnnyomair · 2025-12-22T14:29:44Z

packages/mail-react/package.json

+    },
+    "devDependencies": {
+        "@comet/eslint-config": "workspace:*",
+        "@types/jest": "^29.5.14",


Please remove this package.

jamesricky self-assigned this Dec 15, 2025

jamesricky force-pushed the new-comet-mail-package branch from bade9e2 to 576a772 Compare December 15, 2025 10:15

jamesricky marked this pull request as ready for review December 15, 2025 10:23

auto-assign bot requested a review from johnnyomair December 15, 2025 10:23

Setup @comet/mail package

67cd778

This will be used for helper functions for building HTML emails with React, such as the already included `css` helper. Simple components built with React and/or MJML may also be added in future PRs.

jamesricky force-pushed the new-comet-mail-package branch from 576a772 to 67cd778 Compare December 16, 2025 13:54

johnnyomair reviewed Dec 16, 2025

View reviewed changes

packages/mail/package.json Outdated Show resolved Hide resolved

packages/mail-react/eslint.config.mjs Show resolved Hide resolved

johnnyomair requested a review from thomasdax98 December 16, 2025 14:44

johnnyomair reviewed Dec 16, 2025

View reviewed changes

.changeset/mighty-pants-march.md Show resolved Hide resolved

Changeset for new package (and adjust wording in package description)

fc35e4d

jamesricky marked this pull request as draft December 22, 2025 08:33

jamesricky changed the title ~~Setup @comet/mail package~~ Setup @comet/mail-react package Dec 22, 2025

jamesricky added 2 commits December 22, 2025 09:46

Rename package to mail-react

e314200

Remove unused jest package and scripts

fcec0b3

jamesricky requested review from thomasdax98 and removed request for thomasdax98 December 22, 2025 08:49

jamesricky marked this pull request as ready for review December 22, 2025 08:50

auto-assign bot requested a review from johnnyomair December 22, 2025 08:51

thomasdax98 removed their request for review December 22, 2025 13:26

johnnyomair requested changes Dec 22, 2025

View reviewed changes

Remove unnecessary package

e4eee6a

jamesricky added 3 commits December 22, 2025 15:48

Add missing package

45483ff

Add types and files to package.json

0610604

Remove unnecessary peerDependencies

4220669

jamesricky requested a review from johnnyomair December 22, 2025 14:58

Setup @comet/mail-react package #4951

Are you sure you want to change the base?

Setup @comet/mail-react package #4951

Uh oh!

Conversation

jamesricky commented Dec 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Acceptance criteria

Open TODOs/questions

Further information

Uh oh!

johnnyomair commented Dec 16, 2025

Uh oh!

Uh oh!

Uh oh!

johnnyomair commented Dec 16, 2025

Uh oh!

johnnyomair commented Dec 16, 2025

Uh oh!

Uh oh!

jamesricky commented Dec 16, 2025

Uh oh!

jamesricky commented Dec 16, 2025

Uh oh!

jamesricky commented Dec 16, 2025

Uh oh!

johnnyomair commented Dec 17, 2025

Uh oh!

jamesricky commented Dec 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

johnnyomair commented Dec 22, 2025

Uh oh!

johnnyomair Dec 22, 2025

Choose a reason for hiding this comment

Uh oh!

johnnyomair Dec 22, 2025

Choose a reason for hiding this comment

Uh oh!

jamesricky Dec 22, 2025

Choose a reason for hiding this comment

Uh oh!

johnnyomair Dec 22, 2025

Choose a reason for hiding this comment

Uh oh!

jamesricky Dec 22, 2025

Choose a reason for hiding this comment

Uh oh!

johnnyomair Dec 22, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Setup `@comet/mail-react` package #4951

Setup `@comet/mail-react` package #4951

jamesricky commented Dec 15, 2025 •

edited

Loading

jamesricky commented Dec 19, 2025 •

edited

Loading