inertia_rails 3.14.0 → 3.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e02de8da9dda43a24dae17c59496938d35eef2caa4bade2543d4336201baa0e
-  data.tar.gz: ae6952effd0e1144dc78f2c7f2a3ae9ccc0f1b6011000ef9a7ecfe9f8d9166aa
+  metadata.gz: 2460d1f62147b4360786f5caba3ed7525d0539da9b61acc65dd9c93f925d7e7b
+  data.tar.gz: 741b89dd90fbf8b2fe212ef48ddd1e723ef69d9d13ffa5c35a3cc61d82443743
 SHA512:
-  metadata.gz: 5426c306db138b90256fc924f20f6ce5b68583c431f10f49f1acd5eb64c013b9ed1f4d75472dfab8a971df43a9ad4a03a2854f2a1dff5fbbb4d09748b9b92a0d
-  data.tar.gz: f12bd8e51187679c56a6db6e545687d7ac5c795d20e9d74d5865897b61e9d0308480f4dc06a62fca9d32aa1129041977bdf4be2f69061aaccb3b571972d7d6cc
+  metadata.gz: 06a2bca60142ca5d450b4640fe6fe4df5000b15da57b8830c7993563d827b6d9abec3c3cf036d6ca33cf931a745e40ca81a52706598293e0e619bc4ed5bcb207
+  data.tar.gz: ee907ff350208d0e415aac873cc38b971d9a5fc8964b96dc502d031acd2af6ac5f6ab848163c2e56e60e3b855a1a7c95dc52fda1abbda5e1959a96cb00b068ac

data/CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.15.0] - 2025-12-11
+
+* Support for rendering initial page data in a script tag (@skryukov)
+* Once props support (@skryukov)
+* Fix file references in TypeScript templates (@bigmasonwang)
+
 ## [3.14.0] - 2025-11-27
 
 Lots of quality of life improvements!

data/app/views/inertia.html.erb

@@ -1 +1 @@
-<div id="app" data-page="<%= page.to_json %>"></div>
+<%= inertia_root(page: page) %>

data/lib/generators/inertia/install/templates/initializer.rb

@@ -4,4 +4,5 @@ InertiaRails.configure do |config|
   config.version = ViteRuby.digest
   config.encrypt_history = true
   config.always_include_errors_hash = true
+  config.use_script_element_for_initial_page = true
 end

data/lib/generators/inertia/install/templates/react/InertiaExample.tsx

@@ -34,7 +34,7 @@ export default function InertiaExample(
       <div className={cs.footer}>
         <div className={cs.card}>
           <p>
-            Edit <code><%= js_destination_path %>/pages/inertia_example/index.jsx</code> and save to test <abbr title="Hot Module Replacement">HMR</abbr>.
+            Edit <code><%= js_destination_path %>/pages/inertia_example/index.tsx</code> and save to test <abbr title="Hot Module Replacement">HMR</abbr>.
           </p>
         </div>
 

data/lib/generators/inertia/install/templates/react/inertia.jsx

@@ -44,6 +44,7 @@ createInertiaApp({
       forceIndicesArrayFormatInFormData: false,
     },
     future: {
+      useScriptElementForInitialPage: true,
       useDataInertiaHeadAttribute: true,
       useDialogForErrorModal: true,
       preserveEqualProps: true,

data/lib/generators/inertia/install/templates/react/inertia.tsx

@@ -44,6 +44,7 @@ void createInertiaApp({
       forceIndicesArrayFormatInFormData: false,
     },
     future: {
+      useScriptElementForInitialPage: true,
       useDataInertiaHeadAttribute: true,
       useDialogForErrorModal: true,
       preserveEqualProps: true,

data/lib/generators/inertia/install/templates/svelte/inertia.ts

@@ -42,6 +42,7 @@ createInertiaApp({
       forceIndicesArrayFormatInFormData: false,
     },
     future: {
+      useScriptElementForInitialPage: true,
       useDataInertiaHeadAttribute: true,
       useDialogForErrorModal: true,
       preserveEqualProps: true,

data/lib/generators/inertia/install/templates/vue/InertiaExample.ts.vue

@@ -17,7 +17,7 @@
     <div class="footer">
       <div class="card">
         <p>
-          Edit <code><%= js_destination_path %>/pages/inertia_example/index.ts.vue</code> and save to test <abbr title="Hot Module Replacement">HMR</abbr>.
+          Edit <code><%= js_destination_path %>/pages/inertia_example/index.vue</code> and save to test <abbr title="Hot Module Replacement">HMR</abbr>.
         </p>
       </div>
 

data/lib/generators/inertia/install/templates/vue/inertia.ts

@@ -41,6 +41,7 @@ createInertiaApp({
       forceIndicesArrayFormatInFormData: false,
     },
     future: {
+      useScriptElementForInitialPage: true,
       useDataInertiaHeadAttribute: true,
       useDialogForErrorModal: true,
       preserveEqualProps: true,

data/lib/inertia_rails/base_prop.rb

@@ -3,7 +3,7 @@
 module InertiaRails
   # Base class for all props.
   class BaseProp
-    def initialize(&block)
+    def initialize(**, &block)
       @block = block
     end
 

data/lib/inertia_rails/configuration.rb

@@ -34,6 +34,12 @@ module InertiaRails
 
       # Whether to include empty `errors` hash to the props when no errors are present.
       always_include_errors_hash: nil,
+
+      # Whether to use `<script>` element for initial page rendering instead of the `data-page` attribute.
+      use_script_element_for_initial_page: false,
+
+      # DOM id to use for the root Inertia.js element.
+      root_dom_id: 'app',
     }.freeze
 
     OPTION_NAMES = DEFAULTS.keys.freeze

data/lib/inertia_rails/defer_prop.rb

@@ -2,6 +2,7 @@
 
 module InertiaRails
   class DeferProp < IgnoreOnFirstLoadProp
+    prepend PropOnceable
     prepend PropMergeable
 
     DEFAULT_GROUP = 'default'

data/lib/inertia_rails/helper.rb

@@ -32,5 +32,19 @@ module InertiaRails
 
       safe_join(meta_tags, "\n")
     end
+
+    def inertia_root(id: nil, page: inertia_page)
+      config = controller.send(:inertia_configuration)
+      id ||= config.root_dom_id
+
+      if config.use_script_element_for_initial_page
+        safe_join([
+                    tag.script(page.to_json.html_safe, 'data-page': id, type: 'application/json'),
+                    tag.div(id: id)
+                  ], "\n")
+      else
+        tag.div(id: id, 'data-page': page.to_json)
+      end
+    end
   end
 end

data/lib/inertia_rails/inertia_rails.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'inertia_rails/prop_onceable'
 require 'inertia_rails/prop_mergeable'
 require 'inertia_rails/base_prop'
 require 'inertia_rails/ignore_on_first_load_prop'
@@ -8,6 +9,7 @@ require 'inertia_rails/lazy_prop'
 require 'inertia_rails/optional_prop'
 require 'inertia_rails/defer_prop'
 require 'inertia_rails/merge_prop'
+require 'inertia_rails/once_prop'
 require 'inertia_rails/scroll_prop'
 require 'inertia_rails/configuration'
 require 'inertia_rails/meta_tag'
@@ -36,6 +38,10 @@ module InertiaRails
       AlwaysProp.new(&block)
     end
 
+    def once(...)
+      OnceProp.new(...)
+    end
+
     def merge(...)
       MergeProp.new(...)
     end
@@ -44,8 +50,8 @@ module InertiaRails
       MergeProp.new(deep_merge: true, match_on: match_on, &block)
     end
 
-    def defer(group: nil, merge: nil, deep_merge: nil, match_on: nil, &block)
-      DeferProp.new(group: group, merge: merge, deep_merge: deep_merge, match_on: match_on, &block)
+    def defer(...)
+      DeferProp.new(...)
     end
 
     def scroll(metadata = nil, **options, &block)

data/lib/inertia_rails/merge_prop.rb

@@ -2,6 +2,7 @@
 
 module InertiaRails
   class MergeProp < BaseProp
+    prepend PropOnceable
     prepend PropMergeable
 
     def initialize(**_props, &block)

data/lib/inertia_rails/once_prop.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module InertiaRails
+  class OnceProp < BaseProp
+    prepend PropOnceable
+
+    def initialize(**, &block)
+      @once = true
+      super(&block)
+    end
+  end
+end

data/lib/inertia_rails/optional_prop.rb

@@ -2,5 +2,6 @@
 
 module InertiaRails
   class OptionalProp < IgnoreOnFirstLoadProp
+    prepend PropOnceable
   end
 end

data/lib/inertia_rails/prop_onceable.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module InertiaRails
+  module PropOnceable
+    attr_reader :once_key, :once_expires_in
+
+    def initialize(**props, &block)
+      @once = props.fetch(:once, false)
+      @once_key = props[:key]
+      @once_expires_in = props[:expires_in]
+      @fresh = props.fetch(:fresh, false)
+
+      super
+    end
+
+    def once?
+      @once
+    end
+
+    def fresh?
+      @fresh
+    end
+
+    def expires_at
+      return nil unless @once_expires_in
+
+      timestamp = case @once_expires_in
+                  when ActiveSupport::Duration
+                    (Time.current + @once_expires_in).to_f
+                  when Numeric
+                    Time.current.to_f + @once_expires_in
+                  else
+                    raise ArgumentError, "Invalid `expires_in` value: #{@once_expires_in.inspect}"
+                  end
+
+      (timestamp * 1000).to_i
+    end
+  end
+end

data/lib/inertia_rails/renderer.rb

@@ -48,7 +48,7 @@ module InertiaRails
                                   else
                                     "#{@response.headers['Vary']}, X-Inertia"
                                   end
-      if @request.headers['X-Inertia']
+      if @request.inertia?
         @response.set_header('X-Inertia', 'true')
         @render_method.call json: page.to_json, status: @response.status, content_type: Mime[:json]
       else
@@ -97,15 +97,17 @@ module InertiaRails
     def computed_props
       # rubocop:disable Style/MultilineBlockChain
       @props
-        .tap do |merged_props| # Always keep errors in the props
-          if merged_props.key?(:errors) && !merged_props[:errors].is_a?(BaseProp)
-            errors = merged_props[:errors]
-            merged_props[:errors] = InertiaRails.always { errors }
-          end
+        .tap do |merged_props|
+        # Always keep errors in the props
+        if merged_props.key?(:errors) && !merged_props[:errors].is_a?(BaseProp)
+          errors = merged_props[:errors]
+          merged_props[:errors] = InertiaRails.always { errors }
         end
+      end
         .then { |props| deep_transform_props(props) } # Internal hydration/filtering
         .then { |props| @configuration.prop_transformer(props: props) } # Apply user-defined prop transformer
-        .tap do |props| # Add meta tags last (never transformed)
+        .tap do |props|
+        # Add meta tags last (never transformed)
         props[:_inertia_meta] = meta_tags if meta_tags.present?
       end
       # rubocop:enable Style/MultilineBlockChain
@@ -128,6 +130,9 @@ module InertiaRails
       @page[:scrollProps] = scroll_props if scroll_props.present?
       @page.merge!(resolve_merge_props)
 
+      once_props = resolve_once_props
+      @page[:onceProps] = once_props if once_props.present?
+
       @page
     end
 
@@ -173,6 +178,17 @@ module InertiaRails
       }.delete_if { |_, v| v.blank? }
     end
 
+    def resolve_once_props
+      @props.each_with_object({}) do |(key, prop), result|
+        next unless prop.try(:once?)
+        next if excluded_by_partial_request?([key.to_s])
+
+        once_key = (prop.once_key || key).to_s
+
+        result[once_key] = { prop: key.to_s, expiresAt: prop.expires_at }.compact
+      end
+    end
+
     def resolve_match_on_props
       all_merge_props.filter_map do |key, prop|
         prop.match_on.map! { |ms| "#{key}.#{ms}" } if prop.match_on.present?
@@ -251,6 +267,10 @@ module InertiaRails
       @partial_except_keys ||= (@request.headers['X-Inertia-Partial-Except'] || '').split(',').compact_blank!
     end
 
+    def except_once_keys
+      @except_once_keys ||= (@request.headers['X-Inertia-Except-Once-Props'] || '').split(',').compact_blank!
+    end
+
     def rendering_partial_component?
       @request.headers['X-Inertia-Partial-Component'] == @component
     end
@@ -265,12 +285,8 @@ module InertiaRails
 
     def keep_prop?(prop, path)
       return true if prop.is_a?(AlwaysProp)
-
-      if rendering_partial_component? && (partial_keys.present? || partial_except_keys.present?)
-        path_with_prefixes = path_prefixes(path)
-        return false if excluded_by_only_partial_keys?(path_with_prefixes)
-        return false if excluded_by_except_partial_keys?(path_with_prefixes)
-      end
+      return false if excluded_by_once_cache?(prop, path)
+      return false if excluded_by_partial_request?(path)
 
       # Precedence: Evaluate IgnoreOnFirstLoadProp only after partial keys have been checked
       return false if prop.is_a?(IgnoreOnFirstLoadProp) && !rendering_partial_component?
@@ -278,6 +294,29 @@ module InertiaRails
       true
     end
 
+    def excluded_by_once_cache?(prop, path)
+      return false unless prop.try(:once?)
+      return false if prop.try(:fresh?)
+      return false if explicitly_requested?(path)
+
+      once_key = (prop.once_key || path.join('.')).to_s
+      except_once_keys.include?(once_key)
+    end
+
+    def explicitly_requested?(path)
+      return false unless rendering_partial_component? && partial_keys.present?
+
+      path_with_prefixes = path_prefixes(path)
+      (path_with_prefixes & partial_keys).any?
+    end
+
+    def excluded_by_partial_request?(path)
+      return false unless rendering_partial_component? && (partial_keys.present? || partial_except_keys.present?)
+
+      path_with_prefixes = path_prefixes(path)
+      excluded_by_only_partial_keys?(path_with_prefixes) || excluded_by_except_partial_keys?(path_with_prefixes)
+    end
+
     def path_prefixes(parts)
       (0...parts.length).map do |i|
         parts[0..i].join('.')

data/lib/inertia_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module InertiaRails
-  VERSION = '3.14.0'
+  VERSION = '3.15.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inertia_rails
 version: !ruby/object:Gem::Version
-  version: 3.14.0
+  version: 3.15.0
 platform: ruby
 authors:
 - Brian Knoles
@@ -9,7 +9,7 @@ authors:
 - Eugene Granovsky
 bindir: bin
 cert_chain: []
-date: 2025-11-27 00:00:00.000000000 Z
+date: 2025-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -200,8 +200,10 @@ files:
 - lib/inertia_rails/meta_tag.rb
 - lib/inertia_rails/meta_tag_builder.rb
 - lib/inertia_rails/middleware.rb
+- lib/inertia_rails/once_prop.rb
 - lib/inertia_rails/optional_prop.rb
 - lib/inertia_rails/prop_mergeable.rb
+- lib/inertia_rails/prop_onceable.rb
 - lib/inertia_rails/renderer.rb
 - lib/inertia_rails/rspec.rb
 - lib/inertia_rails/scroll_metadata.rb