refactor!: tighten types, use tempest json\encode and update mago to

1.0.0-beta.24

Author: NeoIsRecursive

composer.json

@@ -39,7 +39,7 @@
   },
   "require-dev": {
     "phpunit/phpunit": "^11.5.15",
-    "carthage-software/mago": "1.0.0-beta.16"
+    "carthage-software/mago": "1.0.0-beta.24"
   },
   "minimum-stability": "dev",
   "config": {

composer.lock

@@ -22,6 +22,7 @@ null-type-hint = "Question"
 integrations = ["phpunit"]
 
 [linter.rules]
+yoda-conditions = { enabled = false }
 ambiguous-function-call = { enabled = false }
 literal-named-argument = { enabled = false }
 halstead = { effort-threshold = 7000 }

mago.toml

@@ -84,7 +84,7 @@ private static function composeProps(array $props, Request $request, string $com
         $always = static::resolveAlwaysProps($props);
         $partial = static::resolvePartialProps($request, $component, $props);
 
-        return static::evaluateProps(array_merge($always, $partial), $request, unpackDotProps: true);
+        return static::evaluateProps(array_merge($always, $partial), unpackDotProps: true);
     }
 
     /**
@@ -131,12 +131,12 @@ private static function resolvePropKeysThatShouldDefer(array $props, Request $re
 
         $propKeysToMerge = arr($props)
             ->filter(static fn($prop) => $prop instanceof DeferProp)
-            ->map(static fn(DeferProp $prop, string $key) => [
+            ->map(static fn(DeferProp $prop, string|int $key) => [
                 'group' => $prop->group,
                 'key' => $key,
             ])
-            ->groupBy(static fn(array $prop) => $prop['group'])
-            ->map(static fn(array $group) => arr($group)->pluck(value: 'key')->toArray());
+            ->groupBy(static fn($prop) => $prop['group'])
+            ->map(static fn($group) => arr($group)->pluck(value: 'key')->toArray());
 
         return $propKeysToMerge->isEmpty() ? null : $propKeysToMerge->toArray();
     }
@@ -158,22 +158,22 @@ private static function resolvePropKeysThatShouldMerge(array $props, Request $re
 
     /**
      * Evaluates props recursively.
+     * @param array<mixed> $props
      * @pure
      * @mago-expect lint:no-boolean-flag-parameter
+     * @mago-expect analysis:mixed-assignment
      */
-    private static function evaluateProps(array $props, Request $request, bool $unpackDotProps = true): array
+    private static function evaluateProps(array $props, bool $unpackDotProps = true): array
     {
-        return arr($props)->map(function ($value, string|int $key) use ($request): array {
+        return arr($props)->map(static function (mixed $value, string|int $key): array {
             $evaluated = $value instanceof Closure ? invoke($value) : $value;
             $evaluated = $evaluated instanceof CallableProp ? $evaluated() : $evaluated;
             $evaluated = $evaluated instanceof ArrayInterface ? $evaluated->toArray() : $evaluated;
-            $evaluated = is_array($evaluated)
-                ? self::evaluateProps($evaluated, $request, unpackDotProps: false)
-                : $evaluated;
+            $evaluated = is_array($evaluated) ? static::evaluateProps($evaluated, unpackDotProps: false) : $evaluated;
 
             return [$key, $evaluated];
         })->reduce(
-            function (array $acc, array $item) use ($unpackDotProps): array {
+            static function (array $acc, array $item) use ($unpackDotProps): array {
                 /** @var string|int $key */
                 [$key, $value] = $item;
                 if ($unpackDotProps && is_string($key) && str_contains($key, '.')) {

src/Http/InertiaResponse.php

@@ -4,12 +4,9 @@
 
 namespace NeoIsRecursive\Inertia;
 
-use Closure;
+use Exception;
 use NeoIsRecursive\Inertia\Http\InertiaResponse;
 use NeoIsRecursive\Inertia\InertiaConfig;
-use NeoIsRecursive\Inertia\Props\AlwaysProp;
-use NeoIsRecursive\Inertia\Props\DeferProp;
-use NeoIsRecursive\Inertia\Props\LazyProp;
 use NeoIsRecursive\Inertia\Support\Header;
 use Tempest\Container\Container;
 use Tempest\Container\Singleton;
@@ -29,10 +26,11 @@ public function __construct(
         private InertiaConfig $config,
     ) {}
 
-    public function share(
-        string|array $key,
-        LazyProp|AlwaysProp|DeferProp|Closure|string|array|null $value = null,
-    ): self {
+    /**
+     * @param string|array<string, mixed> $key
+     */
+    public function share(string|array $key, mixed $value = null): self
+    {
         $this->config->share($key, $value);
 
         return $this;
@@ -49,10 +47,20 @@ public function flushShared(): self
         get => $this->container->invoke($this->config->versionResolver->resolve(...));
     }
 
+    /**
+     * @param array<string, mixed> $props
+     * @mago-expect analyzer:unhandled-thrown-type
+     */
     public function render(string $component, array $props = []): InertiaResponse
     {
+        $request = $this->container->get(Request::class);
+
+        if (!$request) {
+            throw new Exception('No request');
+        }
+
         return new InertiaResponse(
-            request: $this->container->get(Request::class),
+            request: $request,
             component: $component,
             props: array_merge($this->config->sharedProps, $props),
             rootView: $this->config->rootView,
@@ -90,12 +98,13 @@ public function clearHistory(): self
 
     public function location(string|Redirect $url): Response
     {
-        $isInertiaRequest = $this->container->get(Request::class)->headers->has(Header::INERTIA);
+        /** @var bool */
+        $isInertiaRequest = $this->container->get(Request::class)?->headers?->has(Header::INERTIA) ?? false;
 
         if ($isInertiaRequest) {
             if ($url instanceof Redirect) {
                 /** @var string */
-                $url = $url->getHeader(name: 'Location')->values[0];
+                $url = $url->getHeader(name: 'Location')->values[0] ?? '/';
             }
 
             return new GenericResponse(

src/Inertia.php

@@ -4,18 +4,16 @@
 
 namespace NeoIsRecursive\Inertia;
 
-use Closure;
 use NeoIsRecursive\Inertia\Contracts\InertiaVersionResolver;
-use NeoIsRecursive\Inertia\Props\AlwaysProp;
-use NeoIsRecursive\Inertia\Props\DeferProp;
-use NeoIsRecursive\Inertia\Props\LazyProp;
 
 final class InertiaConfig
 {
+    /**
+     * @param array<string, mixed> $sharedProps
+     */
     public function __construct(
         public readonly string $rootView,
         public readonly InertiaVersionResolver $versionResolver = new ManifestVersionResolver(),
-        /** @var array<AlwaysProp|LazyProp|DeferProp|Closure|string|array> */
         public private(set) array $sharedProps = [],
     ) {}
 
@@ -26,7 +24,11 @@ public function flushSharedProps(): self
         return $this;
     }
 
-    public function share(string|array $key, LazyProp|AlwaysProp|DeferProp|Closure|string|array|null $value): self
+    /**
+     * @param (string|array<string, mixed>) $key
+     * @param ($key is string ? mixed : null) $value
+     */
+    public function share(string|array $key, mixed $value = null): self
     {
         if (is_array($key)) {
             $this->sharedProps = array_merge($this->sharedProps, $key);

src/InertiaConfig.php

@@ -19,7 +19,7 @@ final class DeferProp implements CallableProp, MergeableProp
     use IsMergeableProp;
 
     public function __construct(
-        public MethodReflector|FunctionReflector|string|array|Closure $callback,
+        public MethodReflector|FunctionReflector|Closure $callback,
         public string $group = 'default',
         public private(set) bool $shouldMerge = false,
     ) {}

src/Props/DeferProp.php

@@ -19,7 +19,7 @@ final class LazyProp implements CallableProp, MergeableProp
     use IsMergeableProp;
 
     public function __construct(
-        public MethodReflector|FunctionReflector|string|array|Closure $callback,
+        public MethodReflector|FunctionReflector|Closure $callback,
         public private(set) bool $shouldMerge = false,
     ) {}
 

src/Props/LazyProp.php

@@ -24,6 +24,7 @@ public function resolve(): array
 
         return arr($failingRules)->map(
             fn(array $rules): array => arr($rules)->map(
+                // @mago-expect lint:prefer-first-class-callable
                 fn(Rule $rule): string => $this->validator->getErrorMessage($rule),
             )->toArray(),
         )->toArray();

src/Support/ResolveErrorProps.php

@@ -4,10 +4,10 @@
 
 /**
  * @var NeoIsRecursive\Inertia\Views\InertiaBaseView $this
- * @var NeoIsRecursive\Inertia\PageData $page
+ * @var NeoIsRecursive\Inertia\PageData|null $page
  * @var string|null $id
  */
 
 ?>
 
-<div id="<?= $id ?? 'app'; ?>" data-page="<?= htmlentities(json_encode($page ?? $this->page)); ?>"></div>
+<div id="<?= $id ?? 'app'; ?>" data-page="<?= htmlentities(\Tempest\Support\Json\encode($page ?? $this->page)) ?>"></div>