ziggy-js 2.4.2 → 2.5.1

package/README.md

@@ -550,7 +550,7 @@ Route::get('ziggy', fn () => response()->json(new Ziggy));
 
 ### Re-generating the routes file when your app routes change
 
-If you are generating your Ziggy config as a file by running `php artisan ziggy:generate`, you may want to re-run that command when your app's route files change. The example below is a Laravel Mix plugin, but similar functionality could be achieved without Mix. Huge thanks to [Nuno Rodrigues](https://github.com/nacr) for [the idea and a sample implementation](https://github.com/tighten/ziggy/issues/321#issuecomment-689150082). See [#655 for a Vite example](https://github.com/tighten/ziggy/pull/655/files#diff-4aeb78f813e14842fcf95bdace9ced23b8a6eed60b23c165eaa52e8db2f97b61).
+If you are generating your Ziggy config as a file by running `php artisan ziggy:generate`, you may want to re-run that command when your app's route files change. The example below is a Laravel Mix plugin, but similar functionality could be achieved without Mix. Huge thanks to [Nuno Rodrigues](https://github.com/nacr) for [the idea and a sample implementation](https://github.com/tighten/ziggy/issues/321#issuecomment-689150082). See [#655](https://github.com/tighten/ziggy/pull/655/files#diff-4aeb78f813e14842fcf95bdace9ced23b8a6eed60b23c165eaa52e8db2f97b61) or [vite-plugin-ziggy](https://github.com/aniftyco/vite-plugin-ziggy) for Vite examples.
 
 <details>
 <summary>Laravel Mix plugin example</summary>

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "ziggy-js",
-    "version": "2.4.2",
+    "version": "2.5.1",
     "description": "Use your Laravel named routes in JavaScript.",
     "keywords": [
         "laravel",

package/src/js/index.d.ts

@@ -1,5 +1,3 @@
-import { ParsedQs } from 'qs';
-
 /**
  * A list of routes and their parameters and bindings.
  *
@@ -20,13 +18,16 @@ type KnownRouteName = keyof RouteList;
 /**
  * A route name, or any string.
  */
-type RouteName = TypeConfig extends { strictRouteNames: true }
-    ? KnownRouteName
-    : KnownRouteName | (string & {});
+type RouteName = 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.
 
+/**
+ * A valid route name to pass to `route()` to generate a URL.
+ */
+type ValidRouteName = TypeConfig extends { strictRouteNames: true } ? KnownRouteName : RouteName;
+
 /**
  * Information about a single route parameter.
  */
@@ -160,16 +161,21 @@ interface Config {
     };
 }
 
+// qs's parsed query params type, so we don't have to have qs as a dependency
+interface ParsedQs {
+    [key: string]: undefined | string | string[] | ParsedQs | ParsedQs[];
+}
+
 /**
  * Ziggy's Router class.
  */
 interface Router {
-    current(): RouteName | undefined;
-    current<T extends RouteName>(name: T, params?: ParameterValue | RouteParams<T>): boolean;
+    current(): ValidRouteName | undefined;
+    current<T extends ValidRouteName>(name: T, params?: ParameterValue | RouteParams<T>): boolean;
     get params(): Record<string, string>;
     get routeParams(): Record<string, string>;
     get queryParams(): ParsedQs;
-    has<T extends RouteName>(name: T): boolean;
+    has<T extends ValidRouteName>(name: T): boolean;
 }
 
 /**
@@ -187,14 +193,14 @@ export function route(
 ): Router;
 
 // Called with a route name and optional additional arguments - returns a URL string
-export function route<T extends RouteName>(
+export function route<T extends ValidRouteName>(
     name: T,
     params?: RouteParams<T> | undefined,
     absolute?: boolean,
     config?: Config,
 ): string;
 
-export function route<T extends RouteName>(
+export function route<T extends ValidRouteName>(
     name: T,
     params?: ParameterValue | undefined,
     absolute?: boolean,