Merge pull request #68 from istiak-tridip/feat/export-types

feat: introduce route utility types for improved DX

Author: joetannenbaum

composer.json

@@ -28,7 +28,7 @@
     },
     "require-dev": {
         "laravel/pint": "^1.21",
-        "orchestra/testbench": "^10.1"
+        "orchestra/testbench": "^10.1 | ^9.0"
     },
     "autoload": {
         "psr-4": {

resources/function-arguments.blade.ts

@@ -23,4 +23,4 @@ args{!! when($parameters->every->optional, '?') !!}: {
 @endif
 ,
 @endif
-options?: { query?: QueryParams, mergeQuery?: QueryParams }
+options?: RouteQueryOptions

resources/js/wayfinder.ts

@@ -9,10 +9,23 @@ export type QueryParams = Record<
     | Record<string, string | number | boolean>
 >;
 
-export const queryParams = (options?: {
+type Method = "get" | "post" | "put" | "delete" | "patch" | "head";
+
+export type RouteDefinition<TMethod extends Method | Method[]> = {
+    url: string;
+} & (TMethod extends Method[] ? { methods: TMethod } : { method: TMethod });
+
+export type RouteFormDefinition<TMethod extends Method> = {
+    action: string;
+    method: TMethod;
+};
+
+export type RouteQueryOptions = {
     query?: QueryParams;
     mergeQuery?: QueryParams;
-}) => {
+}
+
+export const queryParams = (options?: RouteQueryOptions) => {
     if (!options || (!options.query && !options.mergeQuery)) {
         return "";
     }

resources/method.blade.ts

@@ -1,16 +1,13 @@
 @include('wayfinder::docblock')
-{!! when(($export ?? true) && !$isInvokable, 'export ') !!}const {!! $method !!} = (@include('wayfinder::function-arguments')): {
-    url: string,
-    method: @js($verbs->first()->actual),
-} => ({
+{!! when(($export ?? true) && !$isInvokable, 'export ') !!}const {!! $method !!} = (@include('wayfinder::function-arguments')): RouteDefinition<@js($verbs->first()->actual)> => ({
     url: {!! $method !!}.url({!! when($parameters->isNotEmpty(), 'args, ') !!}options),
     method: @js($verbs->first()->actual),
 })
 
 {!! $method !!}.definition = {
-    methods: [@foreach ($verbs as $verb)@js($verb->actual){!! when(! $loop->last, ',') !!}@endforeach],
+    methods: {!! $verbs->pluck('actual')->toJson() !!},
     url: {!! $uri !!},
-}
+} satisfies RouteDefinition<{!! $verbs->pluck('actual')->toJson() !!}>
 
 @include('wayfinder::docblock')
 {!! $method !!}.url = (@include('wayfinder::function-arguments')) => {
@@ -69,21 +66,15 @@
 
 @foreach ($verbs as $verb)
 @include('wayfinder::docblock')
-{!! $method !!}.{!! $verb->actual !!} = (@include('wayfinder::function-arguments')): {
-    url: string,
-    method: @js($verb->actual),
-} => ({
+{!! $method !!}.{!! $verb->actual !!} = (@include('wayfinder::function-arguments')): RouteDefinition<@js($verb->actual)> => ({
     url: {!! $method !!}.url({!! when($parameters->isNotEmpty(), 'args, ') !!}options),
     method: @js($verb->actual),
 })
 @endforeach
 
 @if ($withForm)
     @include('wayfinder::docblock')
-    const {!! $method !!}Form = (@include('wayfinder::function-arguments')): {
-        action: string,
-        method: @js($verbs->first()->formSafe),
-    } => ({
+    const {!! $method !!}Form = (@include('wayfinder::function-arguments')): RouteFormDefinition<@js($verbs->first()->formSafe)> => ({
         action: {!! $method !!}.url(
             {!! when($parameters->isNotEmpty(), 'args, ') !!}
             @if ($verbs->first()->formSafe === $verbs->first()->actual)
@@ -102,10 +93,7 @@
 
     @foreach ($verbs as $verb)
         @include('wayfinder::docblock')
-        {!! $method !!}Form.{!! $verb->actual !!} = (@include('wayfinder::function-arguments')): {
-            action: string,
-            method: @js($verb->formSafe),
-        } => ({
+        {!! $method !!}Form.{!! $verb->actual !!} = (@include('wayfinder::function-arguments')): RouteFormDefinition<@js($verb->formSafe)> => ({
             action: {!! $method !!}.url(
                 {!! when($parameters->isNotEmpty(), 'args, ') !!}
                 @if ($verb->formSafe === $verb->actual)

src/GenerateCommand.php

@@ -222,7 +222,11 @@ private function writeNamedFile(Collection $routes, string $namespace): void
 
     private function appendCommonImports(Collection $routes, string $path, string $namespace): void
     {
-        $imports = ['queryParams', 'type QueryParams'];
+        $imports = ['queryParams', 'type RouteQueryOptions', 'type RouteDefinition'];
+
+        if ($this->option('with-form') === true) {
+            $imports[] = 'type RouteFormDefinition';
+        }
 
         if ($routes->contains(fn (Route $route) => $route->parameters()->contains(fn (Parameter $parameter) => $parameter->optional))) {
             $imports[] = 'validateParameters';