feat: make params able to be number of boolean (stringable)

.changeset/lazy-actors-poke.md

@@ -0,0 +1,5 @@
+---
+"@bearstudio/lunalink": patch
+---
+
+feat: make params able to be number of boolean (stringable)

packages/lunalink/src/index.spec-d.ts

@@ -9,24 +9,34 @@ const multipleParamsWithDot = "/contacts/:contactId/address/:addressId.html.md";
 
 // Tests OK
 type TestSimpleParamOK = Expect<
-  Equal<ExtractParams<typeof simpleParam>, { id: string }>
+  Equal<
+    ExtractParams<typeof simpleParam>,
+    { id: string | number | boolean }
+  >
 >;
 
 type TestMultipleParamsOK = Expect<
   Equal<
     ExtractParams<typeof multipleParams>,
-    { contactId: string } & { addressId: string }
+    { contactId: string | number | boolean } & {
+      addressId: string | number | boolean;
+    }
   >
 >;
 
 type TestWithDotOK = Expect<
-  Equal<ExtractParams<typeof simpleParamWithDot>, { id: string }>
+  Equal<
+    ExtractParams<typeof simpleParamWithDot>,
+    { id: string | number | boolean }
+  >
 >;
 
 type TestMultipleParamsWithDotOK = Expect<
   Equal<
     ExtractParams<typeof multipleParamsWithDot>,
-    { contactId: string } & { addressId: string }
+    { contactId: string | number | boolean } & {
+      addressId: string | number | boolean;
+    }
   >
 >;
 

packages/lunalink/src/index.spec.ts

@@ -83,6 +83,20 @@ describe("lunalink", () => {
     expect(actual).toBe(expected);
   });
 
+  it("should accept number params without explicit casting", () => {
+    const actual = lunalink("/users/:id", { id: 42 });
+    const expected = "/users/42";
+
+    expect(actual).toBe(expected);
+  });
+
+  it("should accept boolean params without explicit casting", () => {
+    const actual = lunalink("/feature/:flag", { flag: true });
+    const expected = "/feature/true";
+
+    expect(actual).toBe(expected);
+  });
+
   it("should handle params that are followed by a dot (.)", () => {
     const actual = lunalink("/podcasts/:id/episodes/:episodes.html.md", {
       id: "fork-it-community-tech-podcast-fr",

packages/lunalink/src/index.ts

@@ -3,20 +3,23 @@ import queryString from "query-string";
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 type ExplicitAny = any;
 
+/** Accepted types for path parameters */
+type ParamValue = string | number | boolean;
+
 /** Type to extract params from a path */
 export type ExtractParams<Path extends string> =
   // 1) Handle path params with `?`
   Path extends `${string}:${infer Param}?`
-    ? { [K in Param]: string }
+    ? { [K in Param]: ParamValue }
     : // 2) Handle path splitting
       Path extends `${string}:${infer Param}/${infer Rest}`
-      ? { [K in Param]: string } & ExtractParams<`/${Rest}`>
+      ? { [K in Param]: ParamValue } & ExtractParams<`/${Rest}`>
       : // 3) Handle params with dot separator
         Path extends `${string}:${infer Param}.${infer Rest}`
-        ? { [K in Param]: string } & ExtractParams<`${Rest}`>
+        ? { [K in Param]: ParamValue } & ExtractParams<`${Rest}`>
         : // 4) Handle params
           Path extends `${string}:${infer Param}`
-          ? { [K in Param]: string }
+          ? { [K in Param]: ParamValue }
           : // Nothing to extract
             // eslint-disable-next-line @typescript-eslint/no-empty-object-type
             {};