🤖 Merge PR DefinitelyTyped#74805 Add types for route-matcher by @mchevestrier

Author: mchevestrier

types/route-matcher/.npmignore

@@ -0,0 +1,5 @@
+*
+!**/*.d.ts
+!**/*.d.cts
+!**/*.d.mts
+!**/*.d.*.ts

types/route-matcher/index.d.ts

@@ -0,0 +1,14 @@
+export interface StringRoute {
+    parse: (url: string) => Record<string, string> | null;
+    stringify: (params: Record<string, string>) => string;
+}
+
+export interface RegExpRoute {
+    parse: (url: string) => { captures: Array<string | undefined> } | null;
+}
+
+export type StringRouteRule = RegExp | ((value: string) => boolean);
+export type StringRouteRules = Record<string, StringRouteRule>;
+
+export function routeMatcher(route: string, rules?: StringRouteRules): StringRoute;
+export function routeMatcher(route: RegExp): RegExpRoute;

types/route-matcher/package.json

@@ -0,0 +1,17 @@
+{
+    "private": true,
+    "name": "@types/route-matcher",
+    "version": "0.1.9999",
+    "projects": [
+        "https://github.com/cowboy/javascript-route-matcher"
+    ],
+    "devDependencies": {
+        "@types/route-matcher": "workspace:."
+    },
+    "owners": [
+        {
+            "name": "mchevestrier",
+            "githubUsername": "mchevestrier"
+        }
+    ]
+}

types/route-matcher/route-matcher-tests.ts

@@ -0,0 +1,27 @@
+import { routeMatcher } from "route-matcher";
+
+// $ExpectType StringRoute
+const search = routeMatcher("search/:query/p:page");
+
+// $ExpectType Record<string, string> | null
+search.parse("search/cowboy/p5");
+
+// $ExpectType StringRoute
+const user = routeMatcher("user/:id/:other", {
+    id: /^\d+$/,
+    other: function(value) {
+        return value === "" || value === "foo";
+    },
+});
+
+// $ExpectType string
+user.stringify({ id: "abc", other: "xyz" });
+
+// $ExpectType RegExpRoute
+const users = routeMatcher(/^(users?)(?:\/(\d+)(?:\.\.(\d+))?)?/);
+
+// $ExpectType { captures: (string | undefined)[]; } | null
+users.parse("user/123");
+
+// @ts-expect-error - stringification isn't supported for RegExp routes
+users.stringify({ id: "abc", other: "xyz" });

types/route-matcher/tsconfig.json

@@ -0,0 +1,19 @@
+{
+    "compilerOptions": {
+        "module": "node16",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "route-matcher-tests.ts"
+    ]
+}