break: support optional wildcard pattern (#25)

* Optional wildcards

* Wild can be omitted for optional wildcard inject - we're not expecting a null value

* Apply suggestions from code review

* chore: update readme

* chore: update module size

---------

Co-authored-by: Luke Edwards <[email protected]>

Author: benmerckx

index.d.ts

@@ -21,6 +21,8 @@ export type RouteParams<T extends string> =
 		? { [K in P]: string }
 	: T extends `${string}*`
 		? { wild: string }
+	: T extends `${string}*?`
+		? { wild?: string }
 	: {};
 
 export function inject<T extends string>(route: T, values: RouteParams<T>): string;

package.json

@@ -2,7 +2,7 @@
   "name": "regexparam",
   "version": "2.0.2",
   "repository": "lukeed/regexparam",
-  "description": "A tiny (394B) utility that converts route patterns into RegExp. Limited alternative to `path-to-regexp` 🙇‍",
+  "description": "A tiny (405B) utility that converts route patterns into RegExp. Limited alternative to `path-to-regexp` 🙇‍",
   "unpkg": "dist/index.min.js",
   "module": "dist/index.mjs",
   "main": "dist/index.js",

readme.md

@@ -1,6 +1,6 @@
 # regexparam [![CI](https://github.com/lukeed/regexparam/actions/workflows/ci.yml/badge.svg)](https://github.com/lukeed/regexparam/actions/workflows/ci.yml)
 
-> A tiny (394B) utility that converts route patterns into RegExp. Limited alternative to [`path-to-regexp`](https://github.com/pillarjs/path-to-regexp) 🙇
+> A tiny (405B) utility that converts route patterns into RegExp. Limited alternative to [`path-to-regexp`](https://github.com/pillarjs/path-to-regexp) 🙇
 
 With `regexparam`, you may turn a pathing string (eg, `/users/:id`) into a regular expression.
 
@@ -13,6 +13,7 @@ Unlike [`path-to-regexp`](https://github.com/pillarjs/path-to-regexp), this modu
 * Parameter w/ Suffix (`/movies/:title.mp4`, `/movies/:title.(mp4|mov)`)
 * Optional Parameters (`/:title?`, `/books/:title?`, `/books/:genre/:title?`)
 * Wildcards (`*`, `/books/*`, `/books/:genre/*`)
+* Optional Wildcard (`/books/*?`)
 
 This module exposes three module definitions:
 
@@ -35,7 +36,7 @@ import { parse, inject } from 'regexparam';
 // Example param-assignment
 function exec(path, result) {
   let i=0, out={};
-  let matches = result.pattern.exec(path);
+  let matches = result.pattern.exec(path) || [];
   while (i < result.keys.length) {
     out[ result.keys[i] ] = matches[++i] || null;
   }
@@ -82,6 +83,23 @@ let baz = parse('users/*');
 baz.pattern.test('/users'); //=> false
 baz.pattern.test('/users/lukeed'); //=> true
 
+exec('/users', baz);
+//=> { wild: 'lukeed/repos/new' }
+exec('/users/lukeed/repos/new', baz);
+//=> { wild: 'lukeed/repos/new' }
+
+
+// Optional Wildcard
+// ---
+let baz = parse('/users/*?');
+// baz.pattern => /^\/users(?:\/(.*))?(?=$|\/)/i
+// baz.keys => ['wild']
+
+baz.pattern.test('/users'); //=> true
+baz.pattern.test('/users/lukeed'); //=> true
+
+exec('/users', baz);
+//=> { wild: null }
 exec('/users/lukeed/repos/new', baz);
 //=> { wild: 'lukeed/repos/new' }
 

src/index.js

@@ -7,7 +7,7 @@ export function parse(str, loose) {
 		c = tmp[0];
 		if (c === '*') {
 			keys.push('wild');
-			pattern += '/(.*)';
+			pattern += tmp[1] === '?' ? '(?:/(.*))?' : '/(.*)';
 		} else if (c === ':') {
 			o = tmp.indexOf('?', 1);
 			ext = tmp.indexOf('.', 1);

test/inject.js

@@ -64,7 +64,10 @@ run('/foo/:id/:a?/:b?/:bar?', '/foo/123/xxx', { id: 123, bar: 'xxx' });
 run('/foo/:id/:a?/:b?/:bar?', '/foo/123/aa/xxx', { id: 123, a: 'aa', bar: 'xxx' });
 
 run('/foo/:bar/*', '/foo/123', { bar: '123' });
+run('/foo/:bar/*?', '/foo/123', { bar: '123' });
+
 run('/foo/:bar/*', '/foo/123/aa/bb/cc', { bar: '123', wild: 'aa/bb/cc' });
+run('/foo/:bar/*?', '/foo/123/aa/bb/cc', { bar: '123', wild: 'aa/bb/cc' });
 
 // NOTE: Missing non-optional values
 // ---

test/parse.js

@@ -290,7 +290,7 @@ test('execs', () => {
 	toExec('/books/*', '/books/world/howdy/', { wild:'world/howdy/' });
 
 	// console.log('/books/*?');
-	toExec('/books/*?', '/books', false);
+	toExec('/books/*?', '/books', { wild:null });
 	toExec('/books/*?', '/books/', { wild:null });
 	toExec('/books/*?', '/books/world', { wild:'world' });
 	toExec('/books/*?', '/books/world/', { wild:'world/' });
@@ -354,7 +354,7 @@ test('execs :: loose', () => {
 	toLooseExec('/books/*', '/books/world/howdy/', { wild:'world/howdy/' });
 
 	// console.log('/books/*?');
-	toLooseExec('/books/*?', '/books', false);
+	toLooseExec('/books/*?', '/books', { wild:null });
 	toLooseExec('/books/*?', '/books/', { wild:null });
 	toLooseExec('/books/*?', '/books/world', { wild:'world' });
 	toLooseExec('/books/*?', '/books/world/', { wild:'world/' });