Merge pull request #787 from tighten/strict-route-checks

Add ability to strictly type check route names

Author: bakerkretzmar

src/js/index.d.ts

@@ -5,6 +5,11 @@
  */
 export interface RouteList {}
 
+/**
+ * Marker interface to configure Ziggy's type checking behavior.
+ */
+export interface TypeConfig {}
+
 /**
  * A route name registered with Ziggy.
  */
@@ -13,7 +18,9 @@ type KnownRouteName = keyof RouteList;
 /**
  * A route name, or any string.
  */
-type RouteName = KnownRouteName | (string & {});
+type RouteName = TypeConfig extends { strictRouteNames: true }
+    ? KnownRouteName
+    : KnownRouteName | (string & {});
 // `(string & {})` prevents TypeScript from reducing this type to just `string`,
 // which would prevent intellisense from autocompleting known route names.
 // See https://stackoverflow.com/a/61048124/6484459.

tests/js/route.test-d.ts

@@ -102,3 +102,10 @@ assertType(route().current('posts.comments.show', 'foo'));
 assertType<string>(route('optional', { maybe: 'foo' }));
 assertType<string>(route('optional', 'foo'));
 assertType<Router>(route(undefined, undefined, undefined, {} as Config));
+
+// Uncomment to test strict route name checking - invalid route names in this file should error
+// declare module '../../src/js' {
+//     interface TypeConfig {
+//         strictRouteNames: true;
+//     }
+// }