react-email-rails 0.12.0 → 0.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2dc04e0c361e5517d66cf3a60a274b090bc5978b82ee4a77c07758ac8ca82e7
-  data.tar.gz: 027c7e6c6e4510621b6738c271f273a1a89a248e6de59772bc0af6fec7eebe4d
+  metadata.gz: fd436260ad38b370f59dbd8cfad0b09697634624b7c56d0917eee90dc583dc07
+  data.tar.gz: 9e5f81391d9864d46903129e4f4fd2971bca156a83c933c79f8d5e520331b0d8
 SHA512:
-  metadata.gz: b044fc510c92a914031d4932586b12f2a16c306fee35f4cb4088f22093910456b3a8e3fe4a1909d1e8a67ba10a6235462f4531858a6f575e3516ef8bea20e260
-  data.tar.gz: d30686390cf1c1d435a24ec640d3a5873cf7137e211c67e6e316a660c3ffa67ae6c78787b90075676ddab90ded4282b2db6730195120ff954c919fd58a3610f3
+  metadata.gz: a73846be5159e9787b96ea08813051293b75ae697d35c40a25b42cfad9fef66f5c4df2d36369e2c0ca1824b2abfe178a64d8fd39cef4a293d83355b0f5074a3e
+  data.tar.gz: af1228467e11038502e528619e3ca8de5d2b635b97e949fb617aeeb0ff7b1a9ae34ed49fc6024911244ca3ba210b45e90ee15087be0ff17d03694656c3cb8459

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 0.12.2
+
+- The development renderer keeps its Vite cache in `node_modules/.vite/react-email-rails` and skips dependency discovery. It previously reset the app dev server's `node_modules/.vite/deps` on start, so lazily imported dependencies 504ed until that server restarted.
+- Add `config.js_runtime` (default `"node"`) to choose the executable that runs the development renderer, the production bundle, the build task, and the generator's Vite config probe. The gem now runs the package's `bin/*.mjs` scripts directly instead of relying on `node_modules/.bin` shims and their shebangs.
+
+## 0.12.1
+
+- Export `CamelMailer` and `CamelMessage` TypeScript types, plus a `Register` module augmentation (`propKeys: "camel"`) so apps that camelize props can type the injected `mailer` / `message` shapes without a local mapped type. Default `Mailer` / `Message` stay snake_case.
+- Timeouts that already received a partial response line no longer suggest a gem/npm version mismatch. The renderer drains stdout before deciding the process was silent.
+
 ## 0.12.0
 
 - **Breaking:** Remove `config.render_mode`. There is one renderer: a long-lived Node child per Ruby process, speaking newline-delimited JSON. Delete `config.render_mode = :persistent` from initializers. Set `config.render_process_max_requests = 1` to recycle the child after every email.

data/README.md

@@ -2,7 +2,7 @@
 
 # react-email-rails
 
-Build and send Action Mailer emails with [React Email](https://react.email), TypeScript, and Vite.
+Build and send Action Mailer emails with [React Email](https://react.email), Tailwind, TypeScript, and Vite.
 
 react-email-rails lets Rails render React Email components into HTML and plain text, then deliver them through the Action Mailer stack you already know: previews, headers, callbacks, queues, instrumentation, and delivery all keep working normally.
 
@@ -334,6 +334,8 @@ type WelcomeProps = {
 }
 ```
 
+The table shows the default snake_case keys. Keys follow `config.prop_transformer` just like your own props, so a camelize transformer yields `mailerName` / `replyTo` at runtime. Augment `Register` once so `Mailer` / `Message` match, or alias `CamelMailer` / `CamelMessage` — see [Prop Transformation](#prop-transformation).
+
 | Prop | Example |
 |------|---------|
 | `mailer.mailer_name` | `"account_mailer"` |
@@ -343,9 +345,7 @@ type WelcomeProps = {
 | `message.cc`, `message.bcc` | `["…"]` or `null` |
 | `message.from`, `message.reply_to` | `["app@example.com"]` |
 
-Context is merged before prop serialization, so keys follow `config.prop_transformer` just like your own props. The exported TypeScript types describe the default (untransformed) shape.
-
-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.
+Context is merged before prop serialization. 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
 
@@ -427,6 +427,7 @@ end
 | `component_path_resolver` | `->(mailer:, action:) { "#{mailer}/#{action}" }` |
 | `prop_transformer` | `->(props:) { props }` |
 | `render_options` | `{}` |
+| `js_runtime` | `"node"` |
 | `render_timeout` | `30` seconds in development, `10` seconds otherwise |
 | `render_process_max_requests` | `1_000` |
 | `on_render_error` | `nil` |
@@ -435,9 +436,7 @@ end
 
 ### Prop Transformation
 
-Use `prop_transformer` to change props after `as_json` and before they reach React. The default is a no-op, matching [inertia-rails](https://inertia-rails.dev/guide/configuration#prop_transformer).
-
-To work with `snake_case` in Ruby and `camelCase` in components:
+Use `prop_transformer` to change props after `as_json` and before they reach React. To work with `snake_case` in Ruby and `camelCase` in components:
 
 ```ruby
 ReactEmailRails.configure do |config|
@@ -447,6 +446,29 @@ ReactEmailRails.configure do |config|
 end
 ```
 
+The transformer is arbitrary, so TypeScript cannot infer it. The default `Mailer` and `Message` types stay snake_case (`mailer_name`, `reply_to`). App-authored props (`expiresMinutes`, and so on) stay hand-typed in the app.
+
+If you camelize in Ruby, augment `Register` once so `import type { Mailer, Message }` matches runtime — the same "configure once" idea as the initializer:
+
+```ts
+// e.g. react-email-rails.d.ts
+import "react-email-rails"
+
+declare module "react-email-rails" {
+  interface Register {
+    propKeys: "camel"
+  }
+}
+```
+
+The `import "react-email-rails"` (or an `export {}`) makes the file a module so TypeScript *augments* the package. Without it, a script-style `.d.ts` replaces the module and you lose the rest of the package's types.
+
+If you do not want a `.d.ts`, alias the camel types at the import. `CamelMailer` and `CamelMessage` are always camel, regardless of `Register`:
+
+```ts
+import type { CamelMailer as Mailer, CamelMessage as Message } from "react-email-rails"
+```
+
 The transformer receives one hash at a time: the root props object, or each object in a top-level collection. Nested hashes inside a single object are left to the transformer — `deep_transform_keys` walks those.
 
 ### Render Process
@@ -461,6 +483,14 @@ ReactEmailRails.configure do |config|
 end
 ```
 
+`js_runtime` names the executable that runs the renderer, the build task, and the generator's Vite config probe. It defaults to `node` from `PATH`. Point it at an absolute path when Node lives behind a version manager the app process cannot see, or at another runtime such as `bun`. Only Node is tested in CI:
+
+```ruby
+ReactEmailRails.configure do |config|
+  config.js_runtime = "/usr/local/bin/node"
+end
+```
+
 ### Render Options
 
 `render_options` is passed to [@react-email/render](https://react.email/docs/utilities/render). HTML is rendered once; plain text is derived from that markup with `toPlainText` (or `unstableToPlainText` when `unstable_text_conversion` is set). `html.pretty` is applied only to the HTML part, so it does not change the text body. `text.html_to_text_options` is forwarded to `toPlainText`. Option keys are camelized before they cross into JavaScript, so `html_to_text_options` becomes `htmlToTextOptions`.

data/lib/generators/react_email_rails/email_generator.rb

@@ -8,7 +8,7 @@ module ReactEmailRails; end
 module ReactEmailRails::Generators; end
 
 class ReactEmailRails::Generators::EmailGenerator < Rails::Generators::NamedBase
-  CONFIG_BIN = "node_modules/.bin/react-email-rails-config"
+  CONFIG_SCRIPT = "node_modules/react-email-rails/bin/config.mjs"
 
   source_root(File.expand_path("templates/email", __dir__))
 
@@ -120,7 +120,7 @@ class ReactEmailRails::Generators::EmailGenerator < Rails::Generators::NamedBase
       command = vite_config_command
       if command
         stdout, _stderr, status = Timeout.timeout(10) do
-          Open3.capture3(command, chdir: destination_root)
+          Open3.capture3(*command, chdir: destination_root)
         end
 
         status.success? ? JSON.parse(stdout) : {}
@@ -133,10 +133,9 @@ class ReactEmailRails::Generators::EmailGenerator < Rails::Generators::NamedBase
   end
 
   def vite_config_command
-    [
-      CONFIG_BIN,
-      "#{CONFIG_BIN}.cmd",
-    ].find { |path| File.exist?(File.join(destination_root, path)) }
+    return unless File.exist?(File.join(destination_root, CONFIG_SCRIPT))
+
+    [ReactEmailRails.configuration.js_runtime, CONFIG_SCRIPT]
   end
 
   PLUGIN_OPENING = /reactEmailRails\s*\(\s*\{.*?/m

data/lib/react_email_rails/configuration.rb

@@ -1,9 +1,10 @@
 class ReactEmailRails::Configuration
   BUNDLE_PATH = "tmp/react-email-rails/emails.js"
-  BUILD_BIN = "node_modules/.bin/react-email-rails-build"
-  CONFIG_BIN = "node_modules/.bin/react-email-rails-config"
-  DEV_RENDER_BIN = "node_modules/.bin/react-email-rails-dev"
+  BUILD_SCRIPT = "node_modules/react-email-rails/bin/build.mjs"
+  CONFIG_SCRIPT = "node_modules/react-email-rails/bin/config.mjs"
+  DEV_RENDER_SCRIPT = "node_modules/react-email-rails/bin/dev.mjs"
 
+  DEFAULT_JS_RUNTIME = "node"
   DEFAULT_RENDER_TIMEOUT = 10
   DEVELOPMENT_RENDER_TIMEOUT = 30
   DEFAULT_RENDER_PROCESS_MAX_REQUESTS = 1_000
@@ -11,14 +12,6 @@ class ReactEmailRails::Configuration
 
   DEFAULT_PROP_TRANSFORMER = ->(props:) { props }
 
-  DEFAULT_RENDER_COMMAND = lambda do
-    if Rails.env.development?
-      [Rails.root.join(DEV_RENDER_BIN).to_s]
-    else
-      ["node", Rails.root.join(BUNDLE_PATH).to_s]
-    end
-  end
-
   attr_accessor(
     :component_path_resolver,
     :render_options,
@@ -28,6 +21,7 @@ class ReactEmailRails::Configuration
   )
 
   attr_reader(
+    :js_runtime,
     :prop_transformer,
     :render_timeout,
     :render_process_max_requests,
@@ -38,6 +32,7 @@ class ReactEmailRails::Configuration
       new.tap do |config|
         config.component_path_resolver = ->(mailer:, action:) { "#{mailer}/#{action}" }
         config.render_options = {}
+        config.js_runtime = DEFAULT_JS_RUNTIME
         config.render_timeout = Rails.env.development? ? DEVELOPMENT_RENDER_TIMEOUT : DEFAULT_RENDER_TIMEOUT
         config.render_process_max_requests = DEFAULT_RENDER_PROCESS_MAX_REQUESTS
         config.prop_transformer = DEFAULT_PROP_TRANSFORMER
@@ -62,6 +57,12 @@ class ReactEmailRails::Configuration
     @prop_transformer = value
   end
 
+  def js_runtime=(value)
+    raise(ArgumentError, "react-email-rails js_runtime must be a non-empty string") unless value.is_a?(String) && value.present?
+
+    @js_runtime = value
+  end
+
   def render_timeout=(value)
     raise(ArgumentError, "react-email-rails render_timeout must be positive") unless value.is_a?(Numeric) && value.positive?
 
@@ -92,7 +93,8 @@ class ReactEmailRails::Configuration
   private
 
   def resolved_render_command
-    DEFAULT_RENDER_COMMAND.call
+    script = Rails.env.development? ? DEV_RENDER_SCRIPT : BUNDLE_PATH
+    [js_runtime, Rails.root.join(script).to_s]
   end
 
   def serialize_props(props)

data/lib/react_email_rails/renderer/child.rb

@@ -112,9 +112,16 @@ class ReactEmailRails::Renderer::Child
 
       remaining = deadline - monotonic_time
       if remaining <= 0 || IO.select([@stdout], nil, nil, remaining).nil?
-        silent = line.empty? && @stdout_buffer.empty?
+        drain_stdout_nonblock
+        if (buffered_line = consume_buffered_response_line)
+          line << buffered_line
+          return line
+        end
+
+        line << @stdout_buffer
+        @stdout_buffer.clear
         stop
-        raise(Timeout::Error, unmatched_package_message) if silent
+        raise(Timeout::Error, unmatched_package_message) if line.empty?
 
         raise(Timeout::Error)
       end
@@ -134,6 +141,12 @@ class ReactEmailRails::Renderer::Child
     "no response received; gem and npm package react-email-rails must both be #{ReactEmailRails::VERSION}"
   end
 
+  def drain_stdout_nonblock
+    loop { @stdout_buffer << @stdout.read_nonblock(16 * 1024) }
+  rescue IO::WaitReadable, IOError, Errno::EAGAIN, Errno::EINTR
+    nil
+  end
+
   def consume_buffered_response_line
     separator = @stdout_buffer.index("\n")
     return unless separator

data/lib/react_email_rails/renderer.rb

@@ -106,17 +106,16 @@ class ReactEmailRails::Renderer
   end
 
   def validate_command!
-    command_path = command.first.to_s
-    bundle_path = command[1].to_s
+    script = command[1].to_s
+    return if File.file?(script)
 
-    if command_path.end_with?(ReactEmailRails::Configuration::DEV_RENDER_BIN) && !File.exist?(command_path)
-      raise(render_error("development renderer not found at #{command_path.inspect}; install JavaScript dependencies with npm, pnpm, yarn, or bun"))
+    if script.end_with?(ReactEmailRails::Configuration::DEV_RENDER_SCRIPT)
+      raise(render_error("development renderer not found at #{script.inspect}; install JavaScript dependencies with npm, pnpm, yarn, or bun"))
     end
 
-    return unless command_path == "node" && bundle_path.end_with?(ReactEmailRails::Configuration::BUNDLE_PATH)
-    return if File.file?(bundle_path)
+    return unless script.end_with?(ReactEmailRails::Configuration::BUNDLE_PATH)
 
-    raise(render_error("email bundle not found at #{bundle_path.inspect}; run react-email-rails-build before rendering React emails"))
+    raise(render_error("email bundle not found at #{script.inspect}; run react-email-rails-build before rendering React emails"))
   end
 
   def validate_metadata!(body)

data/lib/react_email_rails/tasks.rb

@@ -4,9 +4,9 @@ module ReactEmailRails::Tasks
   class << self
     def build
       command = build_command
-      raise("react-email-rails build command not found at #{command.inspect}; run JavaScript package install first") unless File.exist?(command)
+      raise("react-email-rails build command not found at #{command.last.inspect}; run JavaScript package install first") unless File.exist?(command.last)
 
-      system(command, exception: true, chdir: Rails.root.to_s)
+      system(*command, exception: true, chdir: Rails.root.to_s)
       raise("react-email-rails build completed, but the email bundle was not found at #{bundle_path.inspect}") unless File.file?(bundle_path)
     end
 
@@ -24,12 +24,10 @@ module ReactEmailRails::Tasks
     private
 
     def build_command
-      candidates = [
-        ReactEmailRails::Configuration::BUILD_BIN,
-        "#{ReactEmailRails::Configuration::BUILD_BIN}.cmd",
+      [
+        ReactEmailRails.configuration.js_runtime,
+        Rails.root.join(ReactEmailRails::Configuration::BUILD_SCRIPT).to_s,
       ]
-      candidates.map { |path| Rails.root.join(path).to_s }.find { |path| File.exist?(path) } ||
-        Rails.root.join(ReactEmailRails::Configuration::BUILD_BIN).to_s
     end
 
     def bundle_path

data/lib/react_email_rails/version.rb

@@ -1,3 +1,3 @@
 module ReactEmailRails
-  VERSION = "0.12.0"
+  VERSION = "0.12.2"
 end

metadata

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