ziggy-js 2.6.2 → 2.6.3

package/README.md

@@ -2,7 +2,7 @@
 
 # Ziggy – Use your Laravel routes in JavaScript
 
-[![GitHub Actions Status](https://img.shields.io/github/actions/workflow/status/tighten/ziggy/test.yml?branch=main&style=flat)](https://github.com/tighten/ziggy/actions?query=workflow:Test+branch:2.x)
+[![GitHub Actions Status](https://img.shields.io/github/actions/workflow/status/tighten/ziggy/test.yml?style=flat)](https://github.com/tighten/ziggy/actions/workflows/test.yml)
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/tightenco/ziggy.svg?style=flat)](https://packagist.org/packages/tightenco/ziggy)
 [![Downloads on Packagist](https://img.shields.io/packagist/dt/tightenco/ziggy.svg?style=flat)](https://packagist.org/packages/tightenco/ziggy)
 [![Latest Version on NPM](https://img.shields.io/npm/v/ziggy-js.svg?style=flat)](https://npmjs.com/package/ziggy-js)

package/package.json

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

package/src/js/index.d.ts

@@ -24,9 +24,10 @@ type RouteName = KnownRouteName | (string & {});
 // See https://stackoverflow.com/a/61048124/6484459.
 
 /**
- * A generated route URL string.
+ * A generated route URL string, branded to distinguish it from a plain string.
  */
-export type RouteUrl = string;
+declare const RouteUrlBrand: unique symbol;
+export type RouteUrl = string & { readonly [RouteUrlBrand]: typeof RouteUrlBrand };
 
 /**
  * A valid route name to pass to `route()` to generate a URL.
@@ -114,16 +115,28 @@ type RouteParamsObject<N extends RouteName> = N extends KnownRouteName
 type GenericRouteParamsArray = unknown[];
 /**
  * An array of parameters for a specific named route.
+ *
+ * Required parameters come first as required tuple elements, then optional
+ * parameters become optional tuple elements, followed by arbitrary extras.
  */
 type KnownRouteParamsArray<I extends readonly ParameterInfo[]> = [
-    ...{ [K in keyof I]: Routable<I[K]> },
-    ...unknown[],
+    ...RequiredParamsTuple<I>,
+    ...OptionalParamsTuple<I>,
 ];
-// Because `K in keyof I` for a `readonly` array is always a number, even though this
-// looks like `{ 0: T, 1: U, 2: V }` TypeScript generates `[T, U, V]`. The nested
-// array destructing lets us type the first n items in the array, which are known
-// route parameters, and then allow arbitrary additional items.
-// See https://github.com/tighten/ziggy/pull/664#discussion_r1330002370.
+
+type RequiredParamsTuple<I extends readonly ParameterInfo[]> =
+    I extends readonly [infer F extends ParameterInfo, ...infer R extends ParameterInfo[]]
+        ? F extends { required: true }
+            ? [Routable<F>, ...RequiredParamsTuple<R>]
+            : []
+        : [];
+
+type OptionalParamsTuple<I extends readonly ParameterInfo[]> =
+    I extends readonly [infer F extends ParameterInfo, ...infer R extends ParameterInfo[]]
+        ? F extends { required: false }
+            ? [Routable<F>?, ...OptionalParamsTuple<R>]
+            : OptionalParamsTuple<R>
+        : [...unknown[]];
 
 // Uncomment to test:
 // type B = KnownRouteParamsArray<[{ name: 'post'; required: true; binding: 'uuid' }]>;