@cloudflare/util-routes 5.2.35 → 5.3.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## 5.3.0
+
+### Minor Changes
+
+- a4dce672bb: Add support for optional params
+
+## 5.2.36
+
+### Patch Changes
+
+- 1bc29ca267: Fix: Use IS_RELEASE_CANDIDATE to enable a11y source file attributes in preview builds
+
 ## 5.2.35
 
 ### Patch Changes

package/README.md

@@ -30,3 +30,23 @@ const domainRoute = route`${domainsRoute}/${'domainName'}`
 // => /api/v4/accounts/123/domains/abc.com
 domainRoute.toUrl({ accountId: '123', domainName: 'abc.com' })
 ```
+
+### Optional Parameters
+
+Parameters can be marked optional with a `?` suffix. TypeScript will make them optional in the `toUrl` signature:
+
+```typescript
+const apiRoute = route`/api/${'filter?'}`
+
+// filter is optional in toUrl
+apiRoute.toUrl({}) // => /api
+apiRoute.toUrl({ filter: 'active' }) // => /api/active
+
+// Composing routes with optional params
+const accountsRoute = route`/accounts/${'accountId'}`
+const accountZonesRoute = route`${accountsRoute}/zones/${'filter?'}`
+
+// TypeScript knows filter is optional
+accountZonesRoute.toUrl({ accountId: '123' }) // => /accounts/123/zones
+accountZonesRoute.toUrl({ accountId: '123', filter: 'active' }) // => /accounts/123/zones/active
+```

package/dist/route.d.ts

@@ -6,7 +6,9 @@ export declare class RoutePatternResult<Param extends string> {
      * Interperolate arguments into the route pattern
      */
     readonly toUrl: (args: {
-        [K in Param]: string;
+        [K in RequiredParams<Param>]: string;
+    } & {
+        [K in OptionalParams<Param>]?: string;
     }, options?: pathToRegExp.PathFunctionOptions) => string;
     readonly keys: Key[];
     readonly expression: RegExp;
@@ -20,7 +22,11 @@ export declare type RoutePatternResultFromParams<Params extends Array<string | R
     returnResult: RoutePatternResult<ValueOfArray<Result>>;
     recurse: RoutePatternResultFromParams<Tail<Params>, Prepend<ExtractParam<Head<Params>>, Result>>;
 }[Head<Params> extends never ? 'returnResult' : 'recurse'];
+export declare type StripOptional<T extends string> = T extends `${infer Name}?` ? Name : T;
+export declare type IsOptionalParam<T extends string> = T extends `${string}?` ? true : false;
 export declare type ExtractParam<T extends string | RoutePatternResult<string>> = T extends RoutePatternResult<infer S> ? S : T;
 export declare type ExtractRouteParamsInterface<T extends string | RoutePatternResult<string>> = {
     [K in ExtractParam<T>]: string | undefined;
 };
+export declare type RequiredParams<Params extends string> = Params extends `${infer P}?` ? never : Params extends string ? Params : never;
+export declare type OptionalParams<Params extends string> = Params extends `${infer P}?` ? P : never;

package/es/route.js

@@ -30,7 +30,9 @@ export function route(strings) {
     if (paramName instanceof RoutePatternResult) {
       result += paramName.pattern;
     } else if (typeof paramName === 'string') {
-      result += ':' + paramName;
+      var isOptional = paramName.endsWith('?');
+      var cleanName = isOptional ? paramName.slice(0, -1) : paramName;
+      result += ':' + cleanName + (isOptional ? '?' : '');
     }
 
     return result;

package/lib/route.js

@@ -50,7 +50,9 @@ function route(strings) {
     if (paramName instanceof RoutePatternResult) {
       result += paramName.pattern;
     } else if (typeof paramName === 'string') {
-      result += ':' + paramName;
+      var isOptional = paramName.endsWith('?');
+      var cleanName = isOptional ? paramName.slice(0, -1) : paramName;
+      result += ':' + cleanName + (isOptional ? '?' : '');
     }
 
     return result;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cloudflare/util-routes",
   "description": "Wraps path-to-regexp with a convenient, type-safe tagged template function",
-  "version": "5.2.35",
+  "version": "5.3.0",
   "main": "lib/index.js",
   "module": "es/index.js",
   "author": "Frontend Team <frontend@cloudflare.com>",