Added feature: Merging props

Author: mergehez

InertiaNetCore/Extensions/InertiaExtensions.cs

@@ -6,14 +6,26 @@ namespace InertiaNetCore.Extensions;
 
 internal static class InertiaExtensions
 {
-    internal static List<string> GetPartialData(this ActionContext context)
+    private static List<string> GetInertiaHeaderData(this ActionContext context, string header)
     {
-        return context.HttpContext.Request.Headers.TryGetValue("X-Inertia-Partial-Data", out var data)
+        return context.HttpContext.Request.Headers.TryGetValue(header, out var data)
             ? data.FirstOrDefault()?.Split(",")
                 .Where(s => !string.IsNullOrEmpty(s))
                 .ToList() ?? []
             : [];
     }
+    internal static List<string> GetPartialData(this ActionContext context)
+    {
+        return context.GetInertiaHeaderData("X-Inertia-Partial-Data");
+    }
+    internal static List<string> GetInertiaExcepts(this ActionContext context)
+    {
+        return context.GetInertiaHeaderData("X-Inertia-Partial-Except");
+    }
+    internal static List<string> GetInertiaResetData(this ActionContext context)
+    {
+        return context.GetInertiaHeaderData("X-Inertia-Reset");
+    }
 
     internal static bool IsInertiaPartialComponent(this ActionContext context, string component)
     {

InertiaNetCore/Inertia.cs

@@ -44,4 +44,7 @@ public static class Inertia
 
     public static AlwaysProp<T> Always<T>(Func<T?> callback) => _factory.Always(callback);
     public static AlwaysProp<T> Always<T>(Func<Task<T?>> callback) => _factory.Always(callback);
+    
+    public static MergeProp<T> Merge<T>(Func<T?> callback) => _factory.Merge(callback);
+    public static MergeProp<T> Merge<T>(Func<Task<T?>> callback) => _factory.Merge(callback);
 }

InertiaNetCore/Models/InertiaPage.cs

@@ -4,6 +4,7 @@ public readonly record struct InertiaPage
 {
     public required InertiaProps Props { get; init; }
     public required Dictionary<string, List<string>> DeferredProps { get; init; }
+    public required List<string> MergeProps { get; init; }
     public required string Component { get; init; }
     public required string? Version { get; init; }
     public required string Url { get; init; }

InertiaNetCore/Models/InertiaProps.cs

@@ -4,19 +4,19 @@ namespace InertiaNetCore.Models;
 
 public class InertiaProps : Dictionary<string, object?>
 {
-    internal async Task<InertiaProps> ToProcessedProps(List<string>? partials)
+    internal async Task<InertiaProps> ToProcessedProps(bool isPartial, List<string> partials, List<string> excepts)
     {
         var props = new InertiaProps();
 
-        if(partials is not null && partials.Count == 0)
-            partials = null;
-
         foreach (var (key, value) in this)
         {
-            if(partials is null && value is IIgnoreFirstProp)
+            if(isPartial && excepts.Contains(key, StringComparer.InvariantCultureIgnoreCase))
+                continue;
+            
+            if(!isPartial && value is IIgnoreFirstProp)
                 continue;
 
-            if(partials is not null && value is not IAlwaysProp && !partials.Contains(key, StringComparer.InvariantCultureIgnoreCase))
+            if(isPartial && value is not IAlwaysProp && !partials.Contains(key, StringComparer.InvariantCultureIgnoreCase))
                 continue;
 
             props.Add(key, value switch

InertiaNetCore/Response.cs

@@ -13,7 +13,7 @@ public class Response(string component, InertiaProps props, string? version, Ine
     : IActionResult
 {
     private IDictionary<string, object>? _viewData;
-    
+
     public async Task ExecuteResultAsync(ActionContext context)
     {
         var page = new InertiaPage
@@ -23,8 +23,9 @@ public async Task ExecuteResultAsync(ActionContext context)
             Url = context.HttpContext.RequestedUri(),
             Props = await GetFinalProps(context),
             DeferredProps = GetDeferredProps(context),
+            MergeProps = GetMergeProps(context)
         };
-        
+
         if (!context.HttpContext.IsInertiaRequest())
         {
             var viewData = new ViewDataDictionary(new EmptyModelMetadataProvider(), context.ModelState)
@@ -45,33 +46,36 @@ public async Task ExecuteResultAsync(ActionContext context)
             context.HttpContext.Response.Headers.Append("X-Inertia", "true");
             context.HttpContext.Response.Headers.Append("Vary", "Accept");
             context.HttpContext.Response.StatusCode = 200;
-            
-            var jsonResult = new JsonResult(page, jsonSerializerOptions);
+
+            var jsonResult = new JsonResult(page, options.JsonSerializerOptions);
             await jsonResult.ExecuteResultAsync(context);
         }
     }
-    
+
     private async Task<InertiaProps> GetFinalProps(ActionContext context)
     {
-        var partials = context.IsInertiaPartialComponent(component) ? context.GetPartialData() : null;
+        var isPartial = context.IsInertiaPartialComponent(component);
+        var partials = isPartial ? context.GetPartialData() : [];
+        var excepts = isPartial ? context.GetInertiaExcepts() : [];
+
         var shared = context.HttpContext.Features.Get<InertiaSharedProps>();
-        var flash = context.HttpContext.Features.Get<InertiaFlashMessages>() 
+        var flash = context.HttpContext.Features.Get<InertiaFlashMessages>()
                     ?? InertiaFlashMessages.FromSession(context.HttpContext);
         var errors = GetErrors(context);
-        
-        var finalProps = await props.ToProcessedProps(partials);
-        
+
+        var finalProps = await props.ToProcessedProps(isPartial, partials, excepts);
+
         finalProps = finalProps
             .Merge(shared?.GetData())
             .AddTimeStamp()
             .AddFlash(flash.GetData())
             .AddErrors(errors);
-        
+
         flash.Clear(false);
-        
+
         return finalProps;
     }
-    
+
     private Dictionary<string, List<string>> GetDeferredProps(ActionContext context)
     {
         if (context.IsInertiaPartialComponent(component))
@@ -95,31 +99,50 @@ private Dictionary<string, List<string>> GetDeferredProps(ActionContext context)
                 g => g.Select(x => x.Key).ToList()
             );
     }
-    
+
+    private List<string> GetMergeProps(ActionContext context)
+    {
+        var resetData = context.GetInertiaResetData();
+
+        var tmp = new Dictionary<string, string>();
+        
+        foreach (var (key, value) in props)
+        {
+            if (value is IMergeableProp { Merge: true } && !resetData.Contains(key))
+                tmp[key] = key;
+        }
+        
+        // apply json serialization options to dictionary keys before grouping them
+        var jsonOptions = options.JsonSerializerOptions as JsonSerializerOptions;
+        tmp = JsonSerializer.Deserialize<Dictionary<string, string>>(JsonSerializer.Serialize(tmp, jsonOptions), jsonOptions);
+        
+        return tmp!.Select(prop => prop.Key).ToList();
+    }
+
     private static Dictionary<string, string> GetErrors(ActionContext context)
     {
         var sessionErrors = context.HttpContext.Session.GetString("errors");
         if (sessionErrors is not null)
         {
             var errors = JsonSerializer.Deserialize<Dictionary<string, string>>(sessionErrors);
             context.HttpContext.Session.Remove("errors");
-            
-            if(errors is not null)
+
+            if (errors is not null)
                 return errors;
         }
-        
-        if (context.ModelState.IsValid) 
+
+        if (context.ModelState.IsValid)
             return [];
-        
+
         return context.ModelState.ToDictionary(
             kv => kv.Key,
             kv => kv.Value?.Errors.FirstOrDefault()?.ErrorMessage ?? ""
-            );
+        );
     }
 
     public Response WithViewData(IDictionary<string, object> viewData)
     {
         _viewData = viewData;
         return this;
     }
-}
+}

InertiaNetCore/ResponseFactory.cs

@@ -117,4 +117,6 @@ public void Flash(string key, string? value)
     public DeferredProp<T> Defer<T>(Func<Task<T?>> callback, string? group) => new(callback, group);
     public AlwaysProp<T> Always<T>(Func<T?> callback) => new(callback);
     public AlwaysProp<T> Always<T>(Func<Task<T?>> callback) => new(callback);
+    public MergeProp<T> Merge<T>(Func<T?> callback) => new(callback);
+    public MergeProp<T> Merge<T>(Func<Task<T?>> callback) => new(callback);
 }

InertiaNetCore/Utils/DeferProp.cs

@@ -6,6 +6,7 @@ namespace InertiaNetCore.Utils;
 /// </summary>
 public class DeferredProp<T> : InvokableProp<T>, IDeferredProp
 {
+    public bool Merge { get; set; }
     public string? Group { get; }
 
     public DeferredProp(Func<T?> callback, string? group) : base(callback)

InertiaNetCore/Utils/Interfaces.cs

@@ -17,9 +17,12 @@ internal interface IAlwaysProp;
 
 internal interface IIgnoreFirstProp;
 
-internal interface ILazyProp : IIgnoreFirstProp;
-
-internal interface IDeferredProp : IIgnoreFirstProp
+internal interface IDeferredProp : IIgnoreFirstProp, IMergeableProp
 {
     string? Group { get; }
-}
+}
+
+public interface IMergeableProp
+{
+    bool Merge { get; set; }
+}

InertiaNetCore/Utils/LazyProp.cs

@@ -5,7 +5,7 @@ namespace InertiaNetCore.Utils;
 /// OPTIONALLY included on partial reloads (you should call <c>router.reload({ only: ["propName"] })</c>) <br/>
 /// ONLY evaluated when needed
 /// </summary>
-public class LazyProp<T> : InvokableProp<T>, ILazyProp
+public class LazyProp<T> : InvokableProp<T>, IIgnoreFirstProp
 {
     public LazyProp(Func<T?> callback) : base(callback)
     {

InertiaNetCore/Utils/MergeProp.cs

@@ -0,0 +1,19 @@
+namespace InertiaNetCore.Utils;
+
+/// <summary>
+/// By default, Inertia overwrites props with the same name when reloading a page.
+/// However, there are instances, such as pagination or infinite scrolling, where that is not the desired behavior.
+/// In these cases, you can merge props instead of overwriting them.
+/// </summary>
+public class MergeProp<T> : InvokableProp<T>, IMergeableProp
+{
+    public bool Merge { get; set; } = true;
+
+    public MergeProp(Func<T?> callback) : base(callback)
+    {
+    }
+
+    public MergeProp(Func<Task<T?>> callbackAsync) : base(callbackAsync)
+    {
+    }
+}

README.md

@@ -334,5 +334,5 @@ export default defineConfig({
 ## Work in progress
 
 - [x] Deferred props
-- [ ] Merging props
+- [x] Merging props
 - [ ] History encryption