path-to-regexp 7.0.0 → 8.0.0

package/Readme.md

@@ -17,263 +17,158 @@ npm install path-to-regexp --save
 ## Usage
 
 ```js
-const { pathToRegexp, match, parse, compile } = require("path-to-regexp");
+const { match, compile, parse } = require("path-to-regexp");
 
-// pathToRegexp(path, options?)
 // match(path, options?)
-// parse(path, options?)
 // compile(path, options?)
+// parse(path, options?)
 ```
 
-### Path to regexp
-
-The `pathToRegexp` function returns a regular expression with `keys` as a property. It accepts the following arguments:
-
-- **path** A string.
-- **options** _(optional)_
-  - **sensitive** Regexp will be case sensitive. (default: `false`)
-  - **trailing** Regexp allows an optional trailing delimiter to match. (default: `true`)
-  - **end** Match to the end of the string. (default: `true`)
-  - **start** Match from the beginning of the string. (default: `true`)
-  - **loose** Allow the delimiter to be repeated an arbitrary number of times. (default: `true`)
-  - **delimiter** The default delimiter for segments, e.g. `[^/]` for `:named` parameters. (default: `'/'`)
-  - **encodePath** A function to encode strings before inserting into `RegExp`. (default: `x => x`, recommended: [`encodeurl`](https://github.com/pillarjs/encodeurl))
-
-```js
-const regexp = pathToRegexp("/foo/:bar");
-// regexp = /^\/+foo(?:\/+([^\/]+?))(?:\/+)?$/i
-// keys = [{ name: 'bar', prefix: '', suffix: '', pattern: '', modifier: '' }]
-```
-
-**Please note:** The `RegExp` returned by `path-to-regexp` is intended for ordered data (e.g. pathnames, hostnames). It can not handle arbitrarily ordered data (e.g. query strings, URL fragments, JSON, etc).
-
 ### Parameters
 
-The path argument is used to define parameters and populate keys.
-
-#### Named parameters
-
-Named parameters are defined by prefixing a colon to the parameter name (`:foo`). Parameter names can use any valid unicode identifier characters (similar to JavaScript).
-
-```js
-const regexp = pathToRegexp("/:foo/:bar");
-// keys = [{ name: 'foo', ... }, { name: 'bar', ... }]
-
-regexp.exec("/test/route");
-//=> [ '/test/route', 'test', 'route', index: 0 ]
-```
-
-##### Custom matching parameters
-
-Parameters can have a custom regexp, which overrides the default match (`[^/]+`). For example, you can match digits or names in a path:
+Parameters match arbitrary strings in a path by matching up to the end of the segment, or up to any proceeding tokens. They are defined by prefixing a colon to the parameter name (`:foo`). Parameter names can use any valid JavaScript identifier, or be double quoted to use other characters (`:"param-name"`).
 
 ```js
-const regexpNumbers = pathToRegexp("/icon-:foo(\\d+).png");
-// keys = [{ name: 'foo', ... }]
-
-regexpNumbers.exec("/icon-123.png");
-//=> ['/icon-123.png', '123']
-
-regexpNumbers.exec("/icon-abc.png");
-//=> null
-
-const regexpWord = pathToRegexp("/(user|u)");
-// keys = [{ name: 0, ... }]
-
-regexpWord.exec("/u");
-//=> ['/u', 'u']
+const fn = match("/:foo/:bar");
 
-regexpWord.exec("/users");
-//=> null
+fn("/test/route");
+//=> { path: '/test/route', params: { foo: 'test', bar: 'route' } }
 ```
 
-**Tip:** Backslashes need to be escaped with another backslash in JavaScript strings.
+### Wildcard
 
-#### Unnamed parameters
-
-It is possible to define a parameter without a name. The name will be numerically indexed:
+Wildcard parameters match one or more characters across multiple segments. They are defined the same way as regular parameters, but are prefixed with an asterisk (`*foo`).
 
 ```js
-const regexp = pathToRegexp("/:foo/(.*)");
-// keys = [{ name: 'foo', ... }, { name: '0', ... }]
+const fn = match("/*splat");
 
-regexp.exec("/test/route");
-//=> [ '/test/route', 'test', 'route', index: 0 ]
+fn("/bar/baz");
+//=> { path: '/bar/baz', params: { splat: [ 'bar', 'baz' ] } }
 ```
 
-##### Custom prefix and suffix
+### Optional
 
-Parameters can be wrapped in `{}` to create custom prefixes or suffixes for your segment:
+Braces can be used to define parts of the path that are optional.
 
 ```js
-const regexp = pathToRegexp("{/:attr1}?{-:attr2}?{-:attr3}?");
+const fn = match("/users{/:id}/delete");
 
-regexp.exec("/test");
-// => ['/test', 'test', undefined, undefined]
+fn("/users/delete");
+//=> { path: '/users/delete', params: {} }
 
-regexp.exec("/test-test");
-// => ['/test', 'test', 'test', undefined]
+fn("/users/123/delete");
+//=> { path: '/users/123/delete', params: { id: '123' } }
 ```
 
-#### Modifiers
-
-Modifiers are used after parameters with custom prefixes and suffixes (`{}`).
+## Match
 
-##### Optional
+The `match` function returns a function for matching strings against a path:
 
-Parameters can be suffixed with a question mark (`?`) to make the parameter optional.
+- **path** String or array of strings.
+- **options** _(optional)_ (See [parse](#parse) for more options)
+  - **sensitive** Regexp will be case sensitive. (default: `false`)
+  - **end** Validate the match reaches the end of the string. (default: `true`)
+  - **trailing** Allows optional trailing delimiter to match. (default: `true`)
+  - **decode** Function for decoding strings to params, or `false` to disable all processing. (default: `decodeURIComponent`)
 
 ```js
-const regexp = pathToRegexp("/:foo{/:bar}?");
-// keys = [{ name: 'foo', ... }, { name: 'bar', prefix: '/', modifier: '?' }]
-
-regexp.exec("/test");
-//=> [ '/test', 'test', undefined, index: 0 ]
-
-regexp.exec("/test/route");
-//=> [ '/test/route', 'test', 'route', index: 0 ]
+const fn = match("/foo/:bar");
 ```
 
-##### Zero or more
+**Please note:** `path-to-regexp` is intended for ordered data (e.g. pathnames, hostnames). It can not handle arbitrarily ordered data (e.g. query strings, URL fragments, JSON, etc).
 
-Parameters can be suffixed with an asterisk (`*`) to denote a zero or more parameter matches.
+## Compile ("Reverse" Path-To-RegExp)
 
-```js
-const regexp = pathToRegexp("{/:foo}*");
-// keys = [{ name: 'foo', prefix: '/', modifier: '*' }]
-
-regexp.exec("/foo");
-//=> [ '/foo', "foo", index: 0 ]
-
-regexp.exec("/bar/baz");
-//=> [ '/bar/baz', 'bar/baz', index: 0 ]
-```
-
-##### One or more
+The `compile` function will return a function for transforming parameters into a valid path:
 
-Parameters can be suffixed with a plus sign (`+`) to denote a one or more parameter matches.
+- **path** A string.
+- **options** (See [parse](#parse) for more options)
+  - **encode** Function for encoding input strings for output into the path, or `false` to disable entirely. (default: `encodeURIComponent`)
 
 ```js
-const regexp = pathToRegexp("{/:foo}+");
-// keys = [{ name: 'foo', prefix: '/', modifier: '+' }]
-
-regexp.exec("/");
-//=> null
-
-regexp.exec("/bar/baz");
-//=> [ '/bar/baz', 'bar/baz', index: 0 ]
-```
+const toPath = compile("/user/:id");
 
-#### Wildcard
+toPath({ id: "name" }); //=> "/user/name"
+toPath({ id: "café" }); //=> "/user/caf%C3%A9"
 
-A wildcard can also be used. It is roughly equivalent to `(.*)`.
+const toPathRepeated = compile("/*segment");
 
-```js
-const regexp = pathToRegexp("/*");
-// keys = [{ name: '0', pattern: '[^\\/]*', separator: '/', modifier: '*' }]
+toPathRepeated({ segment: ["foo"] }); //=> "/foo"
+toPathRepeated({ segment: ["a", "b", "c"] }); //=> "/a/b/c"
 
-regexp.exec("/");
-//=> [ '/', '', index: 0 ]
+// When disabling `encode`, you need to make sure inputs are encoded correctly. No arrays are accepted.
+const toPathRaw = compile("/user/:id", { encode: false });
 
-regexp.exec("/bar/baz");
-//=> [ '/bar/baz', 'bar/baz', index: 0 ]
+toPathRaw({ id: "%3A%2F" }); //=> "/user/%3A%2F"
 ```
 
-### Match
-
-The `match` function returns a function for transforming paths into parameters:
-
-- **path** A string.
-- **options** _(optional)_ The same options as `pathToRegexp`, plus:
-  - **decode** Function for decoding strings for params, or `false` to disable entirely. (default: `decodeURIComponent`)
-
-```js
-// Make sure you consistently `decode` segments.
-const fn = match("/user/:id", { decode: decodeURIComponent });
-
-fn("/user/123"); //=> { path: '/user/123', index: 0, params: { id: '123' } }
-fn("/invalid"); //=> false
-fn("/user/caf%C3%A9"); //=> { path: '/user/caf%C3%A9', index: 0, params: { id: 'café' } }
-```
+## Developers
 
-**Note:** Setting `decode: false` disables the "splitting" behavior of repeated parameters, which is useful if you need the exactly matched parameter back.
+- If you are rewriting paths with match and compile, consider using `encode: false` and `decode: false` to keep raw paths passed around.
+- To ensure matches work on paths containing characters usually encoded, such as emoji, consider using [encodeurl](https://github.com/pillarjs/encodeurl) for `encodePath`.
 
-### Compile ("Reverse" Path-To-RegExp)
+### Parse
 
-The `compile` function will return a function for transforming parameters into a valid path:
+The `parse` function accepts a string and returns `TokenData`, the set of tokens and other metadata parsed from the input string. `TokenData` is can used with `match` and `compile`.
 
 - **path** A string.
-- **options** _(optional)_ Similar to `pathToRegexp` (`delimiter`, `encodePath`, `sensitive`, and `loose`), plus:
-  - **validate** When `false` the function can produce an invalid (unmatched) path. (default: `true`)
-  - **encode** Function for encoding input strings for output into the path, or `false` to disable entirely. (default: `encodeURIComponent`)
-
-```js
-const toPath = compile("/user/:id");
+- **options** _(optional)_
+  - **delimiter** The default delimiter for segments, e.g. `[^/]` for `:named` parameters. (default: `'/'`)
+  - **encodePath** A function for encoding input strings. (default: `x => x`, recommended: [`encodeurl`](https://github.com/pillarjs/encodeurl))
 
-toPath({ id: 123 }); //=> "/user/123"
-toPath({ id: "café" }); //=> "/user/caf%C3%A9"
-toPath({ id: ":/" }); //=> "/user/%3A%2F"
+### Tokens
 
-// When disabling `encode`, you need to make sure inputs are encoded correctly. No arrays are accepted.
-const toPathRaw = compile("/user/:id", { encode: false });
+`TokenData` is a sequence of tokens, currently of types `text`, `parameter`, `wildcard`, or `group`.
 
-toPathRaw({ id: "%3A%2F" }); //=> "/user/%3A%2F"
-toPathRaw({ id: ":/" }); //=> "/user/:/", throws when `validate: false` is not set.
+### Custom path
 
-const toPathRepeated = compile("{/:segment}+");
+In some applications, you may not be able to use the `path-to-regexp` syntax, but still want to use this library for `match` and `compile`. For example:
 
-toPathRepeated({ segment: ["foo"] }); //=> "/foo"
-toPathRepeated({ segment: ["a", "b", "c"] }); //=> "/a/b/c"
+```js
+import { TokenData, match } from "path-to-regexp";
 
-const toPathRegexp = compile("/user/:id(\\d+)");
+const tokens = [
+  { type: "text", value: "/" },
+  { type: "parameter", name: "foo" },
+];
+const path = new TokenData(tokens);
+const fn = match(path);
 
-toPathRegexp({ id: "123" }); //=> "/user/123"
+fn("/test"); //=> { path: '/test', index: 0, params: { foo: 'test' } }
 ```
 
-## Developers
-
-- If you are rewriting paths with match and compiler, consider using `encode: false` and `decode: false` to keep raw paths passed around.
-- To ensure matches work on paths containing characters usually encoded, consider using [encodeurl](https://github.com/pillarjs/encodeurl) for `encodePath`.
-- If matches are intended to be exact, you need to set `loose: false`, `trailing: false`, and `sensitive: true`.
-
-### Parse
+## Errors
 
-A `parse` function is available and returns `TokenData`, the set of tokens and other metadata parsed from the input string. `TokenData` is can passed directly into `pathToRegexp`, `match`, and `compile`. It accepts only two options, `delimiter` and `encodePath`, which makes those options redundant in the above methods.
+An effort has been made to ensure ambiguous paths from previous releases throw an error. This means you might be seeing an error when things worked before.
 
-### Token Information
+### Unexpected `?` or `+`
 
-- `name` The name of the token
-- `prefix` _(optional)_ The prefix string for the segment (e.g. `"/"`)
-- `suffix` _(optional)_ The suffix string for the segment (e.g. `""`)
-- `pattern` _(optional)_ The pattern defined to match this token
-- `modifier` _(optional)_ The modifier character used for the segment (e.g. `?`)
-- `separator` _(optional)_ The string used to separate repeated parameters
+In past releases, `?`, `*`, and `+` were used to denote optional or repeating parameters. As an alternative, try these:
 
-## Errors
+- For optional (`?`), use an empty segment in a group such as `/:file{.:ext}`.
+- For repeating (`+`), only wildcard matching is supported, such as `/*path`.
+- For optional repeating (`*`), use a group and a wildcard parameter such as `/files{/*path}`.
 
-An effort has been made to ensure ambiguous paths from previous releases throw an error. This means you might be seeing an error when things worked before.
+### Unexpected `(`, `)`, `[`, `]`, etc.
 
-### Unexpected `?`, `*`, or `+`
+Previous versions of Path-to-RegExp used these for RegExp features. This version no longer supports them so they've been reserved to avoid ambiguity. To use these characters literally, escape them with a backslash, e.g. `"\\("`.
 
-In previous major versions `/` and `.` were used as implicit prefixes of parameters. So `/:key?` was implicitly `{/:key}?`. For example:
+### Missing parameter name
 
-- `/:key?` → `{/:key}?` or `/:key*` → `{/:key}*` or `/:key+` → `{/:key}+`
-- `.:key?` → `{.:key}?` or `.:key*` → `{.:key}*` or `.:key+` → `{.:key}+`
-- `:key?` → `{:key}?` or `:key*` → `{:key}*` or `:key+` → `{:key}+`
+Parameter names, the part after `:` or `*`, must be a valid JavaScript identifier. For example, it cannot start with a number or contain a dash. If you want a parameter name that uses these characters you can wrap the name in quotes, e.g. `:"my-name"`.
 
-### Unexpected `!`, `@`, `,`, or `;`
+### Unterminated quote
 
-These characters have been reserved for future use.
+Parameter names can be wrapped in double quote characters, and this error means you forgot to close the quote character.
 
 ### Express <= 4.x
 
 Path-To-RegExp breaks compatibility with Express <= `4.x` in the following ways:
 
-- The only part of the string that is a regex is within `()`.
-  - In Express.js 4.x, everything was passed as-is after a simple replacement, so you could write `/[a-z]+` to match `/test`.
-- The `?` optional character must be used after `{}`.
+- Regexp characters can no longer be provided.
+- The optional character `?` is no longer supported, use braces instead: `/:file{.:ext}`.
 - Some characters have new meaning or have been reserved (`{}?*+@!;`).
-- The parameter name now supports all unicode identifier characters, previously it was only `[a-z0-9]`.
+- The parameter name now supports all JavaScript identifier characters, previously it was only `[a-z0-9]`.
 
 ## License
 

package/dist/index.d.ts

@@ -8,67 +8,80 @@ export type Encode = (value: string) => string;
 export type Decode = (value: string) => string;
 export interface ParseOptions {
     /**
-     * Set the default delimiter for repeat parameters. (default: `'/'`)
-     */
-    delimiter?: string;
-    /**
-     * Function for encoding input strings for output into path.
+     * A function for encoding input strings.
      */
     encodePath?: Encode;
 }
-export interface PathToRegexpOptions extends ParseOptions {
+export interface MatchOptions {
     /**
-     * When `true` the regexp will be case sensitive. (default: `false`)
-     */
-    sensitive?: boolean;
-    /**
-     * Allow delimiter to be arbitrarily repeated. (default: `true`)
+     * Function for decoding strings for params, or `false` to disable entirely. (default: `decodeURIComponent`)
      */
-    loose?: boolean;
+    decode?: Decode | false;
     /**
-     * When `true` the regexp will match to the end of the string. (default: `true`)
+     * Matches the path completely without trailing characters. (default: `true`)
      */
     end?: boolean;
     /**
-     * When `true` the regexp will match from the beginning of the string. (default: `true`)
-     */
-    start?: boolean;
-    /**
-     * When `true` the regexp allows an optional trailing delimiter to match. (default: `true`)
+     * Allows optional trailing delimiter to match. (default: `true`)
      */
     trailing?: boolean;
-}
-export interface MatchOptions extends PathToRegexpOptions {
-    /**
-     * Function for decoding strings for params, or `false` to disable entirely. (default: `decodeURIComponent`)
-     */
-    decode?: Decode | false;
-}
-export interface CompileOptions extends ParseOptions {
     /**
-     * When `true` the validation will be case sensitive. (default: `false`)
+     * Match will be case sensitive. (default: `false`)
      */
     sensitive?: boolean;
     /**
-     * Allow delimiter to be arbitrarily repeated. (default: `true`)
+     * The default delimiter for segments. (default: `'/'`)
      */
-    loose?: boolean;
-    /**
-     * When `false` the function can produce an invalid (unmatched) path. (default: `true`)
-     */
-    validate?: boolean;
+    delimiter?: string;
+}
+export interface CompileOptions {
     /**
      * Function for encoding input strings for output into the path, or `false` to disable entirely. (default: `encodeURIComponent`)
      */
     encode?: Encode | false;
+    /**
+     * The default delimiter for segments. (default: `'/'`)
+     */
+    delimiter?: string;
+}
+/**
+ * Plain text.
+ */
+export interface Text {
+    type: "text";
+    value: string;
 }
 /**
- * Tokenized path instance. Can we passed around instead of string.
+ * A parameter designed to match arbitrary text within a segment.
+ */
+export interface Parameter {
+    type: "param";
+    name: string;
+}
+/**
+ * A wildcard parameter designed to match multiple segments.
+ */
+export interface Wildcard {
+    type: "wildcard";
+    name: string;
+}
+/**
+ * A set of possible tokens to expand when matching.
+ */
+export interface Group {
+    type: "group";
+    tokens: Token[];
+}
+/**
+ * A sequence of path match characters.
+ */
+export type Token = Text | Parameter | Wildcard | Group;
+/**
+ * Tokenized path instance.
  */
 export declare class TokenData {
     readonly tokens: Token[];
-    readonly delimiter: string;
-    constructor(tokens: Token[], delimiter: string);
+    constructor(tokens: Token[]);
 }
 /**
  * Parse a string for the raw tokens.
@@ -77,7 +90,7 @@ export declare function parse(str: string, options?: ParseOptions): TokenData;
 /**
  * Compile a string to a template function for the path.
  */
-export declare function compile<P extends object = object>(path: Path, options?: CompileOptions): PathFunction<P>;
+export declare function compile<P extends ParamData = ParamData>(path: Path, options?: CompileOptions & ParseOptions): PathFunction<P>;
 export type ParamData = Partial<Record<string, string | string[]>>;
 export type PathFunction<P extends ParamData> = (data?: P) => string;
 /**
@@ -85,7 +98,6 @@ export type PathFunction<P extends ParamData> = (data?: P) => string;
  */
 export interface MatchResult<P extends ParamData> {
     path: string;
-    index: number;
     params: P;
 }
 /**
@@ -96,39 +108,5 @@ export type Match<P extends ParamData> = false | MatchResult<P>;
  * The match function takes a string and returns whether it matched the path.
  */
 export type MatchFunction<P extends ParamData> = (path: string) => Match<P>;
-/**
- * Create path match function from `path-to-regexp` spec.
- */
-export declare function match<P extends ParamData>(path: Path, options?: MatchOptions): MatchFunction<P>;
-/**
- * A key is a capture group in the regex.
- */
-export interface Key {
-    name: string;
-    prefix?: string;
-    suffix?: string;
-    pattern?: string;
-    modifier?: string;
-    separator?: string;
-}
-/**
- * A token is a string (nothing special) or key metadata (capture group).
- */
-export type Token = string | Key;
-/**
- * Repeated and simple input types.
- */
 export type Path = string | TokenData;
-export type PathRegExp = RegExp & {
-    keys: Key[];
-};
-/**
- * Normalize the given path string, returning a regular expression.
- *
- * An empty array can be passed in for the keys, which will hold the
- * placeholder key descriptions. For example, using `/user/:id`, `keys` will
- * contain `[{ name: 'id', delimiter: '/', optional: false, repeat: false }]`.
- */
-export declare function pathToRegexp(path: Path, options?: PathToRegexpOptions): RegExp & {
-    keys: Key[];
-};
+export declare function match<P extends ParamData>(path: Path | Path[], options?: MatchOptions & ParseOptions): MatchFunction<P>;