react-email-rails 0.10.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d0666badbedb79a20a1fec50afc5aedde5398a3777620f5c2f6c2e080a2a5e2
-  data.tar.gz: f19f1dba07f2ad62bf5737e3fab859c33a526305963ee239a1eb63d3048cc7f9
+  metadata.gz: 727de1abdcab5dab75ca38cf157b919b01a74fc6e8c1aef873a658ebed812a68
+  data.tar.gz: 023f5e0bd2ac88a010e8db0a3f1bcdaac28b2cf9424106ad45d2a6ab68a8411a
 SHA512:
-  metadata.gz: 3905f2042d9932512be861bd7bf0be13f7dde1e9f481dae3ebbbe36f676f8562ecc29532a91649e1e64102454427057599d10baa47866ed9bbab6699163546a8
-  data.tar.gz: 6236d1b78f000473a2bb696bbf204ce72143bd62abdc1008a0ce0fa05be88777ca2416101107894f92feaea79d16fbc7f9fc4e13d4c00e8b52ca31dff289fa64
+  metadata.gz: ad68609561536c4eb37215e578d1b94ec37fb77ef80c9334b68e2277a29c10d5d13040fe5817810e430ff067fe7d2ac03960815649897ab424b0fade017981bb
+  data.tar.gz: 77e460b82033c452fd7a4baaa2b711dba701dce6f7c2e572b10f2ddd4b7ad5b87b0b8572b3cd47382adc72a247227a57a8a9e2109ed717e7b23f7d44619ba08a

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.11.1
+
+- Republish of 0.11.0 with no code changes. The 0.11.0 npm package was never published: npm provenance publishing requires GitHub-hosted runners, so the release workflow's publish job now runs on one. Do not use gem 0.11.0; it has no matching npm package.
+
+## 0.11.0
+
+- Generated applications now use React Email 6's unified `react-email` package for email components instead of `@react-email/components`.
+- `@react-email/render` is now a runtime dependency of the `react-email-rails` npm package instead of a peer dependency, so applications no longer install it directly. The npm package now declares `react-dom` as a peer dependency alongside `react`, matching what the renderer already required at runtime.
+
 ## 0.10.0
 
 - **Breaking:** Remove the instance-level `react_share` helper (calling `react_share` from within an action before `mail`). Pass per-mail props directly in the `react:` hash instead; use the class-level `react_share` (with `only`/`except`/`if`/`unless`) for conditional sharing.

data/README.md

@@ -8,16 +8,7 @@ react-email-rails lets Rails render React Email components into HTML and plain t
 
 ## Why
 
-HTML email is still awkward. React Email gives you a nicer component model, email-safe primitives, Tailwind support, and TypeScript. This gem connects that workflow to Rails without replacing Action Mailer.
-
-You get:
-
-- React Email components rendered from `mail(...)`
-- HTML and plain-text output from the same component
-- Rails mailer previews, tests, queues, callbacks, and delivery
-- Vite-powered development rendering
-- A production renderer bundle built during `assets:precompile`
-- Optional persistent rendering for high-volume workers
+HTML email is still awkward. React Email gives you a nicer component model, email-safe primitives, Tailwind support, and TypeScript. This gem connects that workflow to Rails without replacing Action Mailer: components render through Vite in development and a prebuilt renderer bundle in production, with optional persistent rendering for high-volume workers.
 
 ## Status
 
@@ -34,7 +25,6 @@ The supported Ruby, Rails, Node, React, and Vite versions are tested in CI. Plea
 - [Usage](#usage)
 - [Configuration](#configuration)
 - [Deployment](#deployment)
-- [Development](#development)
 - [Contributing](#contributing)
 - [Security](#security)
 - [License](#license)
@@ -43,12 +33,12 @@ The supported Ruby, Rails, Node, React, and Vite versions are tested in CI. Plea
 
 | Dependency | Version |
 |------------|---------|
-| Ruby | >= 3.3 |
-| Rails | Action Mailer, Active Support, and Railties >= 7.1 and < 9.0 |
-| Node | >= 20.19 |
+| Ruby | 3.3+ |
+| Rails | 7.1–8.x |
+| Node | 20.19+ |
 | Vite | 7 or 8 |
 | React | 18 or 19 |
-| `@react-email/render` | 2.x |
+| React Email | 6.x |
 
 We recommend [rails_vite](https://github.com/skryukov/rails_vite/) for Vite in Rails apps.
 
@@ -68,21 +58,20 @@ bundle install
 bin/rails generate react_email_rails:install
 ```
 
-The installer creates `config/initializers/react_email_rails.rb`, installs missing JavaScript dependencies when it can detect your package manager, adds `reactEmailRails()` to `vite.config.*`, and creates `app/javascript/emails`.
+The installer creates `config/initializers/react_email_rails.rb`, installs missing JavaScript dependencies when it can detect your package manager, adds `reactEmailRails()` to `vite.config.*` (creating `vite.config.ts` if none exists), and creates `app/javascript/emails`.
 
 After installation, the normal Rails flow applies:
 
 - Generate mailers and components with `bin/rails generate react_email_rails:email ...`.
 - Run `bin/dev` in development; email components render through Vite on demand.
 - Run `bin/rails assets:precompile` for production; the renderer bundle builds automatically.
-- Run `bin/rails react_email_rails:build` directly when CI or tests need the bundle without the full asset task.
 
 ### Manual Setup
 
 If you prefer to wire things up yourself, install the npm package and React Email dependencies:
 
 ```sh
-npm i react-email-rails @react-email/render @react-email/components react react-dom
+npm i react-email-rails react-email react react-dom
 ```
 
 Use the equivalent command for pnpm, Yarn, or Bun if your app uses a different package manager.
@@ -107,7 +96,7 @@ Generate a mailer and React Email component:
 bin/rails generate react_email_rails:email Account welcome
 ```
 
-The generator follows Rails' mailer generator shape: `NAME [method method]`. It creates a mailer, React component, mailer preview, and test. It also reads `emails.path` and `emails.extension` from `reactEmailRails()` when available.
+The generator follows Rails' mailer generator shape: `NAME [method method]`. It creates a mailer, React component, mailer preview, and test. It also reads `emails.path` and `emails.extension` from your `reactEmailRails()` Vite options when available.
 
 Pass flags when you need to override the detected component directory or extension:
 
@@ -139,7 +128,7 @@ Then edit the generated component:
 
 ```tsx
 // app/javascript/emails/account_mailer/welcome.tsx
-import { Body, Container, Html, Text } from "@react-email/components"
+import { Body, Container, Html, Text } from "react-email"
 
 type WelcomeProps = {
   account: {
@@ -166,7 +155,7 @@ Deliver it like any other Action Mailer email:
 AccountMailer.with(account: current_account).welcome.deliver_later
 ```
 
-React Email also provides primitives like [`<Button>`, `<Heading>`, `<Tailwind>`, and more](https://react.email/docs/components/html).
+React Email also provides primitives like [`<Button>`, `<Heading>`, `<Tailwind>`, and more](https://react.email/components).
 
 ## Rendering
 
@@ -178,9 +167,9 @@ Every `react:` email renders HTML and plain text from the same component. If ren
 
 ### Live-Reloading Previews
 
-In development, Action Mailer previews automatically reload themselves when you edit an email component. react-email-rails registers a [preview interceptor](https://api.rubyonrails.org/classes/ActionMailer/Base.html#class-ActionMailer::Base-label-Previewing+emails) that injects `@vite/client` into the preview, and the `reactEmailRails()` plugin broadcasts a full reload over Vite's websocket whenever a file under your emails directory changes.
+In development, Action Mailer previews automatically reload themselves when you edit an email component. react-email-rails registers a [preview interceptor](https://api.rubyonrails.org/classes/ActionMailer/Base.html#class-ActionMailer::Base-label-Previewing+emails) that injects `@vite/client` into the preview, and the `reactEmailRails()` plugin broadcasts a full reload over Vite's WebSocket whenever a file under your emails directory changes.
 
-The `live_reload_url` defaults to Vite's `http://localhost:5173`, but you can point elsewhere if needed, or set it to a falsy value to disable live reload. (See [Configuration](#configuration))
+`live_reload_url` defaults to Vite's `http://localhost:5173`. Point it elsewhere if your dev server runs on a different port, or set it to a falsy value to disable live reload:
 
 ```ruby
 ReactEmailRails.configure do |config|
@@ -192,31 +181,7 @@ end
 
 ### Passing Props
 
-Top-level keys passed to `react:` become props on the component's default export. The API is intentionally close to [inertia-rails](https://inertia-rails.dev), so apps using both libraries should feel consistent.
-
-```ruby
-mail(
-  to: account.email,
-  subject: "Welcome",
-  react: {
-    account: {
-      name: account.name,
-    },
-  },
-)
-```
-
-```tsx
-type WelcomeProps = {
-  account: {
-    name: string
-  }
-}
-
-export default function Welcome({ account }: WelcomeProps) {
-  // ...
-}
-```
+Top-level keys passed to `react:` become props on the component's default export, as shown in the [Quick Start](#quick-start). The API is intentionally close to [inertia-rails](https://inertia-rails.dev), so apps using both libraries should feel consistent.
 
 ### Component Inference
 
@@ -249,7 +214,7 @@ class AccountMailer < ApplicationMailer
 end
 ```
 
-Action Mailer's framework assigns, including `params` and `rendered_format`, are excluded from instance props.
+Action Mailer's internal assigns, such as `params` and `rendered_format`, are excluded from instance props.
 
 To make React the default for every action, set `default react: true` on the mailer (or `ApplicationMailer`). Each `mail` call then renders the inferred component without repeating `react: true`, and a single action can opt back out with `react: false`:
 
@@ -361,26 +326,12 @@ Every `react:` email receives `mailer` and `message` props, mirroring the [`mail
 
 ```tsx
 import type { Mailer, Message } from "react-email-rails"
-import { Body, Container, Html, Text } from "@react-email/components"
 
 type WelcomeProps = {
   account: { name: string }
   mailer: Mailer
   message: Message
 }
-
-export default function Welcome({ account, mailer, message }: WelcomeProps) {
-  return (
-    <Html>
-      <Body>
-        <Container>
-          <Text>Welcome, {account.name}</Text>
-          <Text>Re: {message.subject}</Text>
-        </Container>
-      </Body>
-    </Html>
-  )
-}
 ```
 
 | Prop | Example |
@@ -394,7 +345,7 @@ export default function Welcome({ account, mailer, message }: WelcomeProps) {
 
 Context is merged before prop serialization, so keys follow `config.transform_props` just like your own props. The exported TypeScript types describe the default `:lower_camel` shape.
 
-Per-mail and shared props win on conflict, so a prop named `mailer` or `message` overrides the injected context. Serializer props receive the context when `as_json` returns a hash. Collections, arrays, and other non-object values pass through unchanged so their top-level shape is preserved.
+Per-mail and shared props win on conflict, so a prop named `mailer` or `message` overrides the injected context. When props come from a serializer, the context is merged in as long as `as_json` returns a hash; collections, arrays, and other non-object values pass through unchanged so their top-level shape is preserved.
 
 ### Prop Serialization
 
@@ -404,7 +355,7 @@ Prop keys are camelized by default, so `plan_name` arrives in React as `planName
 
 ### Component Files
 
-Files and directories starting with `_` are ignored as renderable email entries by default. Use them for shared components, layouts, and helpers:
+Files and directories starting with `_` are excluded from the email component registry by default. Use them for shared components, layouts, and helpers:
 
 ```text
 app/javascript/emails/
@@ -422,7 +373,7 @@ Action Mailer layouts are not applied to `react:` emails. In React Email, layout
 
 ```tsx
 // app/javascript/emails/_components/email_layout.tsx
-import { Body, Container, Html } from "@react-email/components"
+import { Body, Container, Html } from "react-email"
 import type { ReactNode } from "react"
 
 type EmailLayoutProps = {
@@ -442,7 +393,7 @@ export function EmailLayout({ children }: EmailLayoutProps) {
 
 ```tsx
 // app/javascript/emails/account_mailer/welcome.tsx
-import { Text } from "@react-email/components"
+import { Text } from "react-email"
 import { EmailLayout } from "../_components/email_layout"
 
 export default function Welcome() {
@@ -526,7 +477,7 @@ Persistent mode details:
 
 ### Render Options
 
-`render_options` is passed to [@react-email/render](https://react.email/docs/utilities/render). Use `html` and `text` keys to configure each output. Option keys are camelized before they cross into JavaScript.
+`render_options` is passed to [@react-email/render](https://react.email/docs/utilities/render). Use `html` and `text` keys to configure each output. Option keys are camelized before they cross into JavaScript, so `html_to_text_options` becomes `htmlToTextOptions`.
 
 ```ruby
 ReactEmailRails.configure do |config|
@@ -561,7 +512,7 @@ The callback receives the error plus render context such as `component:`.
 
 ### Instrumentation
 
-Every render emits `render.react-email-rails` through [ActiveSupport::Notifications](https://guides.rubyonrails.org/active_support_instrumentation.html). Payloads include `component` and successful HTML size in `html_bytes`.
+Every render emits `render.react-email-rails` through [ActiveSupport::Notifications](https://guides.rubyonrails.org/active_support_instrumentation.html). Payloads include the `component` and, on success, the rendered HTML size in `html_bytes`.
 
 ```ruby
 ActiveSupport::Notifications.subscribe("render.react-email-rails") do |event|
@@ -574,18 +525,9 @@ end
 
 ### Vite Configuration
 
-Most apps only need the plugin from [Installation](#installation):
-
-```ts
-import { defineConfig } from "vite"
-import { reactEmailRails } from "react-email-rails"
-
-export default defineConfig({
-  plugins: [reactEmailRails()],
-})
-```
+Most apps only need the bare `reactEmailRails()` plugin from [Installation](#installation).
 
-The isolated renderer loads `reactEmailRails()`, JSX support, and component-facing Vite config such as `resolve`, `define`, `css`, `json`, `assetsInclude`, `esbuild`, and `oxc`. It does not load your other app plugins unless you explicitly add them with `vite.plugins`.
+The isolated renderer loads `reactEmailRails()`, JSX support, and component-facing Vite config such as `assetsInclude`, `css`, `define`, `esbuild`, `json`, `oxc`, and `resolve`. It does not load your other app plugins unless you explicitly add them with `vite.plugins`.
 
 Server, preview, dependency optimization, and build output settings stay owned by react-email-rails so Rails can always find the renderer bundle.
 
@@ -617,7 +559,7 @@ reactEmailRails({
 })
 ```
 
-Component names come from the Vite directory layout. To map mailer actions to a different layout, override `component_path_resolver` on the Ruby side so both halves stay in sync.
+Component names come from the file layout under `emails.path`. To map mailer actions to a different layout, override `component_path_resolver` on the Ruby side so both halves stay in sync.
 
 ### Email-Only Vite Plugins
 
@@ -653,7 +595,7 @@ reactEmailRails({
 })
 ```
 
-Externalized bundles can be smaller and may build faster, but the externalized packages must be available at runtime.
+Externalized bundles can be smaller and may build faster, but the packages they reference must be available at runtime.
 
 ## Deployment
 
@@ -663,7 +605,7 @@ Production deploys should run the normal Rails asset task:
 bin/rails assets:precompile
 ```
 
-react-email-rails hooks `react_email_rails:build` into `assets:precompile`. The build task loads `reactEmailRails()` options from your Vite config and writes `tmp/react-email-rails/emails.js` with the email component registry.
+react-email-rails hooks `react_email_rails:build` into `assets:precompile` (and `react_email_rails:clobber` into `assets:clobber`). The build task loads `reactEmailRails()` options from your Vite config and writes `tmp/react-email-rails/emails.js` with the email component registry.
 
 You can run the renderer build directly:
 
@@ -673,9 +615,9 @@ bin/rails react_email_rails:build
 
 Production rendering requires that bundle. If it is missing, rendering raises `ReactEmailRails::RenderError` and Action Mailer does not send the email.
 
-Set `SKIP_REACT_EMAIL_RAILS_BUILD=1` to skip the automatic asset hook. Directly running `bin/rails react_email_rails:build` always attempts the build.
+Set `SKIP_REACT_EMAIL_RAILS_BUILD=1` to skip the automatic asset hooks. Directly running `bin/rails react_email_rails:build` always attempts the build.
 
-The npm package, Vite, React, and `@react-email/render` must be available when Rails runs `assets:precompile`.
+The npm package, Vite, and React must be available when Rails runs `assets:precompile`.
 
 The Ruby gem and npm package must stay on the same version. A protocol/version handshake catches mismatched installs and raises an actionable `ReactEmailRails::RenderError`.
 
@@ -701,29 +643,9 @@ end
 
 If you check at boot, scope it to processes that send mail so the rest of the app does not pay the cost.
 
-## Development
-
-See [CONTRIBUTING.md](CONTRIBUTING.md) for local setup, checks, formatting, and release verification.
-
-The short version:
-
-```sh
-bundle install
-cd vite && pnpm install
-```
-
-Run the core checks before opening a pull request:
-
-```sh
-ruby scripts/check_version_sync.rb
-bin/test
-bin/lint
-cd vite && pnpm run build
-```
-
 ## Contributing
 
-Bug reports and pull requests are welcome. Please read [CONTRIBUTING.md](CONTRIBUTING.md) before opening a pull request so the local checks and release expectations are clear.
+Bug reports and pull requests are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for local setup, the checks to run before opening a pull request, and release expectations.
 
 ## Security
 

data/lib/generators/react_email_rails/install_generator.rb

@@ -7,8 +7,7 @@ module ReactEmailRails::Generators; end
 class ReactEmailRails::Generators::InstallGenerator < Rails::Generators::Base
   JAVASCRIPT_PACKAGES = [
     "react-email-rails",
-    "@react-email/render",
-    "@react-email/components",
+    "react-email",
     "react",
     "react-dom",
   ].freeze

data/lib/generators/react_email_rails/templates/email/component.tsx

@@ -1,4 +1,4 @@
-import { Body, Container, Heading, Html, Text } from "@react-email/components"
+import { Body, Container, Heading, Html, Text } from "react-email"
 
 export default function <%= @component_name %>() {
   return (

data/lib/react_email_rails/mailer_context.rb

@@ -33,8 +33,8 @@ class ReactEmailRails::MailerContext
   def message_context
     message = mailer.message
 
-    MESSAGE_FIELDS.each_with_object({}) do |field, context|
-      context[field.to_s] = message.public_send(field)
+    MESSAGE_FIELDS.to_h do |field|
+      [field.to_s, message.public_send(field)]
     end
   end
 end

data/lib/react_email_rails/version.rb

@@ -1,3 +1,3 @@
 module ReactEmailRails
-  VERSION = "0.10.0"
+  VERSION = "0.11.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: react-email-rails
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Supertape