Add support for resolving props once in Inertia middleware and response

Author: michaelnabil230

src/Inertia.php

@@ -14,6 +14,7 @@
  * @method static void version(\Closure|string|null $version)
  * @method static string getVersion()
  * @method static void resolveUrlUsing(\Closure|null $urlResolver = null)
+ * @method static void resolveOncePropsUsing(\Closure|null $urlResolver = null)
  * @method static \Inertia\OptionalProp optional(callable $callback)
  * @method static \Inertia\LazyProp lazy(callable $callback)
  * @method static \Inertia\DeferProp defer(callable $callback, string $group = 'default')

src/Middleware.php

@@ -79,6 +79,16 @@ public function urlResolver()
         return null;
     }
 
+    /**
+     * Defines the props that are shared for one time.
+     *
+     * @return Closure|null
+     */
+    public function oncePropsResolver()
+    {
+        return null;
+    }
+
     /**
      * Handle the incoming request.
      *
@@ -97,6 +107,10 @@ public function handle(Request $request, Closure $next)
             Inertia::resolveUrlUsing($urlResolver);
         }
 
+        if ($oncePropsResolver = $this->oncePropsResolver()) {
+            Inertia::resolveOncePropsUsing($oncePropsResolver);
+        }
+
         $response = $next($request);
         $response->headers->set('Vary', Header::INERTIA);
 

src/Response.php

@@ -38,6 +38,8 @@ class Response implements Responsable
 
     protected ?Closure $urlResolver = null;
 
+    protected ?Closure $oncePropsResolver = null;
+
     /**
      * @param  array|Arrayable  $props
      */
@@ -47,7 +49,8 @@ public function __construct(
         string $rootView = 'app',
         string $version = '',
         bool $encryptHistory = false,
-        ?Closure $urlResolver = null
+        ?Closure $urlResolver = null,
+        ?Closure $oncePropsResolver = null,
     ) {
         $this->component = $component;
         $this->props = $props instanceof Arrayable ? $props->toArray() : $props;
@@ -56,6 +59,7 @@ public function __construct(
         $this->clearHistory = session()->pull('inertia.clear_history', false);
         $this->encryptHistory = $encryptHistory;
         $this->urlResolver = $urlResolver;
+        $this->oncePropsResolver = $oncePropsResolver;
     }
 
     /**
@@ -132,6 +136,8 @@ public function toResponse($request)
             return new JsonResponse($page, 200, [Header::INERTIA => 'true']);
         }
 
+        $page += $this->resolveOnceProps($request);
+
         return ResponseFactory::view($this->rootView, $this->viewData + ['page' => $page]);
     }
 
@@ -376,6 +382,15 @@ public function resolveDeferredProps(Request $request): array
         return $deferredProps->isNotEmpty() ? ['deferredProps' => $deferredProps->toArray()] : [];
     }
 
+    public function resolveOnceProps(Request $request): array
+    {
+        $onceProps = $this->oncePropsResolver
+            ? App::call($this->oncePropsResolver, ['request' => $request])
+            : [];
+
+        return ['onceProps' => $onceProps];
+    }
+
     /**
      * Determine if the request is a partial request.
      */

src/ResponseFactory.php

@@ -35,7 +35,10 @@ class ResponseFactory
     /** @var Closure|null */
     protected $urlResolver;
 
-    /***
+    /** @var Closure|null */
+    protected $oncePropsResolver;
+
+    /**
      * @param string $name The name of the root view
      * @return void
      */
@@ -102,6 +105,11 @@ public function resolveUrlUsing(?Closure $urlResolver = null): void
         $this->urlResolver = $urlResolver;
     }
 
+    public function resolveOncePropsUsing(?Closure $oncePropsResolver = null): void
+    {
+        $this->oncePropsResolver = $oncePropsResolver;
+    }
+
     public function clearHistory(): void
     {
         session(['inertia.clear_history' => true]);
@@ -189,6 +197,7 @@ public function render(string $component, $props = []): Response
             $this->getVersion(),
             $this->encryptHistory ?? config('inertia.history.encrypt', false),
             $this->urlResolver,
+            $this->oncePropsResolver,
         );
     }
 

stubs/middleware.stub

@@ -40,4 +40,16 @@ class {{ class }} extends Middleware
             //
         ];
     }
+
+    /**
+     * Defines the props that are shared for one time.
+     *
+     * @return Closure
+     */
+    public function oncePropsResolver()
+    {
+        return function (Request $request): array {
+            return [];
+        };
+    }
 }