react-email-rails 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 957e5d57adf900478fa7736755f400bd424dbfc4aa47bee2e6ef82822fa9d048
-  data.tar.gz: 7bdd67d8de3ce6051c1849338337e74734fb51514d18eee0931ba172c2edac93
+  metadata.gz: 8a57e71ae6b09c032c117a6e3cb0e30c2913340b91bf3ed1c3a8480ca8b04355
+  data.tar.gz: 1880d340ee6dc94daeafe63386b90d775c99b8eaedcbad9704d55a70b3854456
 SHA512:
-  metadata.gz: 7e44fad8be9e76043f9811a5cadffc9ffe4a6da0dd4b649b283a6f5af599d600d4c69750a2dc454224923abab985204f07238978def3fd2ca3af7506c73444d6
-  data.tar.gz: 86617b862cfaf09b4a20a21918b042732648d8a8383dcf319cbe4ba77e5f982d9dd98d0abdc643d8ef902dfcc46485f0428547c0aed2a2eccae7e508a87ee5c2
+  metadata.gz: 60ce6e92fe530cd05aede3d905985d36e4aa08c8167c0a6248908f7453930dd30f0e32e14f4a6921cb9ad1fbcade89054a4c95b627df07282900e6a753542b14
+  data.tar.gz: b8a0ca20d81079a24a1c7c62400bd42d60b4c559a60189cdc948be8c61236016c56251999231825152c2a5ca11e266f572a8549b8e9fbd0f15d8d3224487f34e

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 0.9.0
+
+- **Breaking:** Rename `react_email_share` to `react_share`, matching the `react:` key used in `mail`. Update any `react_email_share` calls in your mailers to `react_share`.
+
+## 0.8.0
+
+- **Breaking:** Remove `@react-email/editor` document rendering to focus the library on component-based Action Mailer emails. `ReactEmailRails.compose`, `ReactEmailRails.parse`, the `documents` Vite plugin option, and the `react-email-rails/document` module are gone, along with the `@react-email/editor`, `@tiptap/core`, `@tiptap/html`, `happy-dom`, and `marked` optional peer dependencies.
+- **Breaking:** `on_render_error` callbacks and the `render.react-email-rails` instrumentation payload no longer include `kind:` (every render is a component email again); `RenderedEmail` no longer has `warnings`.
+- Bump the render protocol to 4 (the renderer no longer accepts document or parse requests). The Ruby gem and npm package must be upgraded together, as before.
+
 ## 0.7.0
 
 - Add development live-reloading for Action Mailer previews. A development-only preview interceptor injects Vite's `@vite/client` into previews, and the `reactEmailRails()` plugin triggers a full reload when an email component changes, so the open preview refreshes on save. Configure the dev-server URL with `live_reload_url`, or set it to a falsy value to disable.

data/README.md

@@ -18,7 +18,6 @@ You get:
 - Vite-powered development rendering
 - A production renderer bundle built during `assets:precompile`
 - Optional persistent rendering for high-volume workers
-- Optional server-side rendering for `@react-email/editor` documents
 
 ## Status
 
@@ -281,15 +280,15 @@ To change naming globally, override `component_path_resolver` in your [Rails con
 
 ### Shared Props
 
-Use `react_email_share` to merge props into every `react:` email for a mailer and its subclasses:
+Use `react_share` to merge props into every `react:` email for a mailer and its subclasses:
 
 ```ruby
 class MarketingMailer < ApplicationMailer
-  react_email_share app_name: "Acme"
+  react_share app_name: "Acme"
 
-  react_email_share unread_count: -> { params[:account]&.unread_count }
+  react_share unread_count: -> { params[:account]&.unread_count }
 
-  react_email_share do
+  react_share do
     { brand: { name: "Acme", url: marketing_url } }
   end
 end
@@ -311,14 +310,14 @@ Shared props work with `react:` hashes, `react: true`, and explicit `react: "com
 
 ### Conditional Shared Props
 
-`react_email_share` accepts the same filter options as `before_action`: `only`, `except`, `if`, and `unless`.
+`react_share` accepts the same filter options as `before_action`: `only`, `except`, `if`, and `unless`.
 
 ```ruby
-react_email_share only: [:welcome, :reactivation] do
+react_share only: [:welcome, :reactivation] do
   { promotion: params.fetch(:promotion) }
 end
 
-react_email_share if: :account_active? do
+react_share if: :account_active? do
   { account: { name: params.fetch(:account).name } }
 end
 ```
@@ -329,7 +328,7 @@ You can also share props inside an action before calling `mail`:
 def welcome
   account = params.fetch(:account)
 
-  react_email_share notice: "Thanks for joining!"
+  react_share notice: "Thanks for joining!"
 
   mail(
     to: account.email,
@@ -346,7 +345,7 @@ Shared props are merged shallowly by default. That means a per-mail prop replace
 Pass `deep_merge: true` to merge nested hashes instead:
 
 ```ruby
-react_email_share do
+react_share do
   { settings: { theme: "light", locale: "en" } }
 end
 
@@ -471,12 +470,6 @@ export default function Welcome() {
 }
 ```
 
-### Editor Documents
-
-If your app uses [@react-email/editor](https://react.email/docs/editor) to let users compose emails visually, `ReactEmailRails.compose` can render stored editor documents on the server.
-
-See [Editor rendering](docs/editor.md) for setup and usage.
-
 ## Configuration
 
 Configuration lives in two places:
@@ -580,11 +573,11 @@ ReactEmailRails.configure do |config|
 end
 ```
 
-The callback receives the error plus render context such as `kind:` and `component:`.
+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). Email payloads include `kind`, `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 `component` and successful HTML size in `html_bytes`.
 
 ```ruby
 ActiveSupport::Notifications.subscribe("render.react-email-rails") do |event|
@@ -619,7 +612,6 @@ Server, preview, dependency optimization, and build output settings stay owned b
 | `emails.path` | `"app/javascript/emails"` | Directory containing email components |
 | `emails.extension` | `[".tsx", ".jsx"]` | Component extension, or an array of extensions |
 | `emails.ignore` | `["**/_*", "**/_*/**"]` | Glob patterns ignored under `emails.path` |
-| `documents` | `false` | Optional `@react-email/editor` document renderer discovery; see [Editor rendering](docs/editor.md) |
 | `standalone` | `true` | Inline production renderer bundle dependencies |
 | `vite` | `{}` | Extra email-only Vite config for compilation and resolution |
 
@@ -687,7 +679,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. If [Editor rendering](docs/editor.md) is enabled, the bundle also includes document renderers.
+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.
 
 You can run the renderer build directly:
 
@@ -699,7 +691,7 @@ Production rendering requires that bundle. If it is missing, rendering raises `R
 
 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.
 
-The npm package, Vite, React, and `@react-email/render` must be available when Rails runs `assets:precompile`. If [Editor rendering](docs/editor.md) is enabled, its peer dependencies must be available too.
+The npm package, Vite, React, and `@react-email/render` 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`.
 

data/SECURITY.md

@@ -3,7 +3,3 @@
 Please report security issues privately by emailing hi@supertape.com.
 
 Do not open a public GitHub issue for suspected vulnerabilities. Include the affected version, a minimal reproduction when possible, and any relevant deployment details.
-
-## Rendering editor documents
-
-`ReactEmailRails.compose` renders an `@react-email/editor` document (Tiptap/ProseMirror JSON) server-side. Treat that document as untrusted input: it is typically authored in a visual editor and stored, then rendered later. The renderer only dispatches to the extensions you register for that document type, and React Email escapes rendered output, but URL and asset sanitization inside your custom extensions (links, image sources, button hrefs) remains your application's responsibility. Validate or sanitize those values where you build extensions or transform the document.

data/lib/react_email_rails/action_mailer.rb

@@ -12,7 +12,7 @@ module ReactEmailRails::ActionMailer
       self.react_email_use_instance_props = true
     end
 
-    def react_email_share(hash = nil, **props, &block)
+    def react_share(hash = nil, **props, &block)
       options = props.slice(*SHARED_FILTER_OPTIONS)
       data = hash || props.except(*SHARED_FILTER_OPTIONS)
 
@@ -22,7 +22,7 @@ module ReactEmailRails::ActionMailer
     end
   end
 
-  def react_email_share(hash = nil, **props, &block)
+  def react_share(hash = nil, **props, &block)
     react_email_append_shared(hash || props, block)
   end
 

data/lib/react_email_rails/render_modes/persistent/server.rb

@@ -75,8 +75,6 @@ class ReactEmailRails::RenderModes::Persistent::Server
       }.tap do |body|
         body[:html] = response["html"] if response.key?("html")
         body[:text] = response["text"] if response.key?("text")
-        body[:warnings] = response["warnings"] if response.key?("warnings")
-        body[:document] = response["document"] if response.key?("document")
       end,
     ))
   rescue JSON::ParserError => e

data/lib/react_email_rails/render_modes/subprocess.rb

@@ -8,10 +8,9 @@ class ReactEmailRails::RenderModes::Subprocess
     end
   end
 
-  def initialize(payload:, label:, response: :email)
+  def initialize(payload:, label:)
     @payload = payload
     @label = label
-    @response = response
   end
 
   def render
@@ -20,7 +19,7 @@ class ReactEmailRails::RenderModes::Subprocess
 
   private
 
-  attr_reader(:payload, :label, :response)
+  attr_reader(:payload, :label)
 
   def run
     result = capture(payload_json)
@@ -28,7 +27,7 @@ class ReactEmailRails::RenderModes::Subprocess
 
     body = JSON.parse(result.stdout)
     validate_metadata!(body)
-    build_result(body)
+    build_rendered_email(body)
   rescue JSON::ParserError => e
     raise(render_error("render process returned invalid JSON: #{e.message}"))
   rescue KeyError => e
@@ -86,32 +85,12 @@ class ReactEmailRails::RenderModes::Subprocess
     raise(render_error(ReactEmailRails::RenderProtocol.mismatch_message(body)))
   end
 
-  def build_result(body)
-    response == :document ? build_document(body) : build_rendered_email(body)
-  end
-
   def build_rendered_email(body)
     raise(KeyError.new(key: "html")) unless body.key?("html")
     raise(render_error("render process returned an invalid response: html must be a string")) unless body["html"].is_a?(String)
     raise(render_error("render process returned an invalid response: text must be a string")) if body.key?("text") && !body["text"].is_a?(String)
 
-    ReactEmailRails::RenderedEmail.new(html: body.fetch("html"), text: body["text"].to_s, warnings: warnings_from(body))
-  end
-
-  def build_document(body)
-    raise(KeyError.new(key: "document")) unless body.key?("document")
-
-    document = body.fetch("document")
-    raise(render_error("parse process returned an invalid response: document must be an object")) unless document.is_a?(Hash)
-
-    document
-  end
-
-  def warnings_from(body)
-    warnings = body["warnings"]
-    return [] unless warnings.is_a?(Array)
-
-    warnings.filter_map { |warning| warning.transform_keys(&:to_sym) if warning.is_a?(Hash) }
+    ReactEmailRails::RenderedEmail.new(html: body.fetch("html"), text: body["text"].to_s)
   end
 
   def render_error(message)

data/lib/react_email_rails/render_protocol.rb

@@ -1,7 +1,7 @@
 require("json")
 
 module ReactEmailRails
-  RENDER_PROTOCOL_VERSION = 3
+  RENDER_PROTOCOL_VERSION = 4
 
   module RenderProtocol
     extend(self)

data/lib/react_email_rails/rendered_email.rb

@@ -1,7 +1,3 @@
 module ReactEmailRails
-  RenderedEmail = Data.define(:html, :text, :warnings) do
-    def initialize(html:, text:, warnings: [])
-      super
-    end
-  end
+  RenderedEmail = Data.define(:html, :text)
 end

data/lib/react_email_rails/version.rb

@@ -1,3 +1,3 @@
 module ReactEmailRails
-  VERSION = "0.7.0"
+  VERSION = "0.9.0"
 end

data/lib/react_email_rails.rb

@@ -44,29 +44,12 @@ module ReactEmailRails
       payload = { component:, props: serialized_props(props) }
       payload[:renderOptions] = render_options if render_options.present?
 
-      perform(payload:, label: component, kind: "email", component:)
-    end
-
-    def compose(type:, document:, context: {}, preview: nil)
-      payload = {
-        kind: "document",
-        type:,
-        document: document.as_json,
-        context: serialized_props(context),
-        preview:,
-      }
-
-      perform(payload:, label: type, kind: "document", type:)
-    end
-
-    def parse(type:, html: nil, markdown: nil, context: {})
-      payload = {
-        kind: "parse",
-        type:,
-        context: serialized_props(context),
-      }.merge(parse_source(html:, markdown:))
-
-      perform(payload:, label: type, response: :document, kind: "parse", type:)
+      instrument(component:) do
+        configuration.resolved_render_mode.new(payload:, label: component).render
+      end
+    rescue ReactEmailRails::RenderError => e
+      configuration.on_render_error&.call(e, component:)
+      raise
     end
 
     def healthy?
@@ -80,38 +63,13 @@ module ReactEmailRails
 
     private
 
-    def perform(payload:, label:, response: :email, **metadata)
-      instrument(**metadata) do
-        configuration.resolved_render_mode.new(payload:, label:, response:).render
-      end
-    rescue ReactEmailRails::RenderError => e
-      configuration.on_render_error&.call(e, **metadata)
-      raise
-    end
-
-    def parse_source(html:, markdown:)
-      if !html.nil? && !markdown.nil?
-        raise(ArgumentError, "ReactEmailRails.parse accepts only one of html: or markdown:")
-      end
-
-      return { html: html.to_s } unless html.nil?
-      return { markdown: markdown.to_s } unless markdown.nil?
-
-      raise(ArgumentError, "ReactEmailRails.parse requires html: or markdown:")
-    end
-
     def serialized_props(value)
       configuration.send(:serialize_props, value)
     end
 
-    def instrument(**metadata)
-      ActiveSupport::Notifications.instrument("render.react-email-rails", **metadata) do |payload|
-        yield.tap do |result|
-          next unless result.respond_to?(:html)
-
-          payload[:html_bytes] = result.html.bytesize
-          payload[:warnings] = result.warnings if result.warnings.present?
-        end
+    def instrument(component:)
+      ActiveSupport::Notifications.instrument("render.react-email-rails", component:) do |payload|
+        yield.tap { |result| payload[:html_bytes] = result.html.bytesize }
       end
     end
   end

metadata

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