wip

Author: pascalbaljet

.gitattributes

@@ -11,3 +11,5 @@
 /tests export-ignore
 /CHANGELOG.md export-ignore
 /README.md export-ignore
+/phpstan-macros.php export-ignore
+/phpstan.neon export-ignore

composer.json

@@ -39,7 +39,7 @@
         "orchestra/testbench": "^8.0|^9.2|^10.0",
         "mockery/mockery": "^1.3.3",
         "phpunit/phpunit": "^10.4|^11.5",
-        "laravel/pint": "^1.16",
+        "laravel/pint": "^1.24",
         "larastan/larastan": "^3.0"
     },
     "suggest": {

src/AlwaysProp.php

@@ -4,21 +4,21 @@
 
 use Illuminate\Support\Facades\App;
 
-/**
- * A property that is always included in Inertia responses.
- * Bypasses partial reload filtering to ensure critical data is available.
- */
 class AlwaysProp
 {
     /**
      * The property value.
      *
+     * Always included in Inertia responses, bypassing partial reload filtering.
+     *
      * @var mixed
      */
     protected $value;
 
     /**
-     * Create a new always property instance.
+     * Create a new always property instance. Always properties are included
+     * in every Inertia response, even during partial reloads when only
+     * specific props are requested.
      *
      * @param  mixed  $value
      */

src/Controller.php

@@ -6,6 +6,10 @@
 
 class Controller
 {
+    /**
+     * Handle the incoming request and render the Inertia response.
+     * Renders the component and props defined in the route defaults.
+     */
     public function __invoke(Request $request): Response
     {
         return Inertia::render(

src/DeferProp.php

@@ -4,17 +4,15 @@
 
 use Illuminate\Support\Facades\App;
 
-/**
- * A property that is loaded asynchronously after the initial page render.
- * Implements lazy loading for improved page performance.
- */
 class DeferProp implements IgnoreFirstLoad, Mergeable
 {
     use MergesProps;
 
     /**
      * The callback to resolve the property.
      *
+     * Loaded asynchronously after initial page render for performance.
+     *
      * @var callable
      */
     protected $callback;
@@ -27,7 +25,9 @@ class DeferProp implements IgnoreFirstLoad, Mergeable
     protected $group;
 
     /**
-     * Create a new deferred property instance.
+     * Create a new deferred property instance. Deferred properties are excluded
+     * from the initial page load and only evaluated when requested by the
+     * frontend, improving initial page performance.
      */
     public function __construct(callable $callback, ?string $group = null)
     {
@@ -36,7 +36,9 @@ public function __construct(callable $callback, ?string $group = null)
     }
 
     /**
-     * Get the defer group.
+     * Get the defer group for this property. Properties with the same group
+     * are loaded together in a single request, allowing for efficient
+     * batching of related deferred data.
      *
      * @return string|null
      */

src/Directive.php

@@ -5,7 +5,9 @@
 class Directive
 {
     /**
-     * Compile the "@inertia" Blade directive.
+     * Compile the "@inertia" Blade directive. This directive renders the
+     * Inertia root element with the page data, handling both client-side
+     * rendering and SSR fallback scenarios.
      *
      * @param  string  $expression
      */
@@ -30,7 +32,9 @@ public static function compile($expression = ''): string
     }
 
     /**
-     * Compile the "@inertiaHead" Blade directive.
+     * Compile the "@inertiaHead" Blade directive. This directive renders the
+     * head content for SSR responses, including meta tags, title, and other
+     * head elements from the server-side render.
      *
      * @param  string  $expression
      */

src/EncryptHistoryMiddleware.php

@@ -8,7 +8,9 @@
 class EncryptHistoryMiddleware
 {
     /**
-     * Handle the incoming request.
+     * Handle the incoming request and enable history encryption. This middleware
+     * enables encryption of the browser history state, providing additional
+     * security for sensitive data in Inertia responses.
      *
      * @return \Symfony\Component\HttpFoundation\Response
      */

src/LazyProp.php

@@ -5,8 +5,6 @@
 use Illuminate\Support\Facades\App;
 
 /**
- * A property that is excluded from initial page loads but evaluated during partial reloads.
- *
  * @deprecated Use OptionalProp instead for clearer semantics.
  */
 class LazyProp implements IgnoreFirstLoad

src/MergeProp.php

@@ -4,23 +4,23 @@
 
 use Illuminate\Support\Facades\App;
 
-/**
- * A property that merges with existing client-side data during partial reloads.
- * Supports both shallow and deep merging strategies.
- */
 class MergeProp implements Mergeable
 {
     use MergesProps;
 
     /**
      * The property value.
      *
+     * Merged with existing client-side data during partial reloads.
+     *
      * @var mixed
      */
     protected $value;
 
     /**
-     * Create a new merge property instance.
+     * Create a new merge property instance. Merge properties are combined
+     * with existing client-side data during partial reloads instead of
+     * completely replacing the property value.
      *
      * @param  mixed  $value
      */

src/OptionalProp.php

@@ -4,21 +4,21 @@
 
 use Illuminate\Support\Facades\App;
 
-/**
- * A property that is only included when explicitly requested via partial reloads.
- * Enables on-demand evaluation for performance optimization.
- */
 class OptionalProp implements IgnoreFirstLoad
 {
     /**
      * The callback to resolve the property.
      *
+     * Only included when explicitly requested via partial reloads.
+     *
      * @var callable
      */
     protected $callback;
 
     /**
-     * Create a new optional property instance.
+     * Create a new optional property instance. Optional properties are only
+     * included when explicitly requested via partial reloads, reducing
+     * initial payload size and improving performance.
      */
     public function __construct(callable $callback)
     {