Fix #202 (#203)

tatethurston · Oct 8, 2024 · 01b9efd · 01b9efd
1 parent 0516c38
commit 01b9efd
Show file tree

Hide file tree

Showing 7 changed files with 28 additions and 17 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 2.2.3
+
+- Bug fix: `usePathname` and `useParams` were incorrectly resolving to `any` return types.
+
 ## 2.2.2
 
 - Adds support for Next.js's `app` directory. `Link` accepts either static routes (no url parameters) or a `RouteLiteral` string, which can be generated by the `route` helper from this library:

diff --git a/examples/app/@types/nextjs-routes.d.ts b/examples/app/@types/nextjs-routes.d.ts
@@ -192,7 +192,7 @@ declare module "next/navigation" {
    *
    * Read more: [Next.js Docs: `usePathname`](https://nextjs.org/docs/app/api-reference/functions/use-pathname)
    */
-  export const usePathname = () => RouteLiteral;
+  export const usePathname: () => RouteLiteral;
 
   type AppRouterInstance = Omit<NextAppRouterInstance, 'push' | 'replace' | 'href'> & {
     push(href: StaticRoute | RouteLiteral, options?: NavigateOptions): void;
@@ -237,5 +237,5 @@ declare module "next/navigation" {
    *
    * Read more: [Next.js Docs: `useParams`](https://nextjs.org/docs/app/api-reference/functions/use-params)
    */
-  export const useParams = <Pathname extends Route["pathname"] = Route["pathname"]>() => RoutedQuery<Pathname>;
+  export const useParams: <Pathname extends Route["pathname"] = Route["pathname"]>() => RoutedQuery<Pathname>;
 }
diff --git a/packages/e2e/@types/nextjs-routes.d.ts b/packages/e2e/@types/nextjs-routes.d.ts
@@ -194,7 +194,7 @@ declare module "next/navigation" {
    *
    * Read more: [Next.js Docs: `usePathname`](https://nextjs.org/docs/app/api-reference/functions/use-pathname)
    */
-  export const usePathname = () => RouteLiteral;
+  export const usePathname: () => RouteLiteral;
 
   type AppRouterInstance = Omit<NextAppRouterInstance, 'push' | 'replace' | 'href'> & {
     push(href: StaticRoute | RouteLiteral, options?: NavigateOptions): void;
@@ -239,5 +239,5 @@ declare module "next/navigation" {
    *
    * Read more: [Next.js Docs: `useParams`](https://nextjs.org/docs/app/api-reference/functions/use-params)
    */
-  export const useParams = <Pathname extends Route["pathname"] = Route["pathname"]>() => RoutedQuery<Pathname>;
+  export const useParams: <Pathname extends Route["pathname"] = Route["pathname"]>() => RoutedQuery<Pathname>;
 }
diff --git a/packages/e2e/typetest.tsx b/packages/e2e/typetest.tsx
@@ -25,6 +25,11 @@ nextRoutes({ foo: false });
 // eslint-disable-next-line @typescript-eslint/no-unused-vars, @typescript-eslint/no-empty-function
 function expectType<T>(_value: T) {}
 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars, @typescript-eslint/no-empty-function
+function expectNotAny<T>(_value: NotAny<T>) {}
+
+type NotAny<T> = unknown extends T ? never : T;
+
 // next/link
 
 // Links with string hrefs
@@ -350,7 +355,9 @@ expectType<(href: string, options: PrefetchOptions) => void>(
   useAppRouter().prefetch,
 );
 
+expectNotAny(usePathname());
 expectType<RouteLiteral>(usePathname());
 
+expectNotAny(useParams());
 expectType<RoutedQuery>(useParams());
 expectType<RoutedQuery<"/bars/[bar]">>(useParams<"/bars/[bar]">());
diff --git a/packages/nextjs-routes/package.json b/packages/nextjs-routes/package.json
@@ -1,6 +1,6 @@
 {
   "name": "nextjs-routes",
-  "version": "2.2.2",
+  "version": "2.2.3",
   "description": "Type safe routing for Next.js",
   "license": "MIT",
   "author": "Tate <[email protected]>",

diff --git a/packages/nextjs-routes/src/__snapshots__/core.test.ts.snap b/packages/nextjs-routes/src/__snapshots__/core.test.ts.snap
@@ -203,7 +203,7 @@ declare module "next/navigation" {
    *
    * Read more: [Next.js Docs: \`usePathname\`](https://nextjs.org/docs/app/api-reference/functions/use-pathname)
    */
-  export const usePathname = () => RouteLiteral;
+  export const usePathname: () => RouteLiteral;
 
   type AppRouterInstance = Omit<NextAppRouterInstance, 'push' | 'replace' | 'href'> & {
     push(href: StaticRoute | RouteLiteral, options?: NavigateOptions): void;
@@ -248,7 +248,7 @@ declare module "next/navigation" {
    *
    * Read more: [Next.js Docs: \`useParams\`](https://nextjs.org/docs/app/api-reference/functions/use-params)
    */
-  export const useParams = <Pathname extends Route["pathname"] = Route["pathname"]>() => RoutedQuery<Pathname>;
+  export const useParams: <Pathname extends Route["pathname"] = Route["pathname"]>() => RoutedQuery<Pathname>;
 }
 ",
   ],
@@ -452,7 +452,7 @@ declare module "next/navigation" {
    *
    * Read more: [Next.js Docs: \`usePathname\`](https://nextjs.org/docs/app/api-reference/functions/use-pathname)
    */
-  export const usePathname = () => RouteLiteral;
+  export const usePathname: () => RouteLiteral;
 
   type AppRouterInstance = Omit<NextAppRouterInstance, 'push' | 'replace' | 'href'> & {
     push(href: StaticRoute | RouteLiteral, options?: NavigateOptions): void;
@@ -497,7 +497,7 @@ declare module "next/navigation" {
    *
    * Read more: [Next.js Docs: \`useParams\`](https://nextjs.org/docs/app/api-reference/functions/use-params)
    */
-  export const useParams = <Pathname extends Route["pathname"] = Route["pathname"]>() => RoutedQuery<Pathname>;
+  export const useParams: <Pathname extends Route["pathname"] = Route["pathname"]>() => RoutedQuery<Pathname>;
 }
 ",
   ],
@@ -702,7 +702,7 @@ declare module "next/navigation" {
    *
    * Read more: [Next.js Docs: \`usePathname\`](https://nextjs.org/docs/app/api-reference/functions/use-pathname)
    */
-  export const usePathname = () => RouteLiteral;
+  export const usePathname: () => RouteLiteral;
 
   type AppRouterInstance = Omit<NextAppRouterInstance, 'push' | 'replace' | 'href'> & {
     push(href: StaticRoute | RouteLiteral, options?: NavigateOptions): void;
@@ -747,7 +747,7 @@ declare module "next/navigation" {
    *
    * Read more: [Next.js Docs: \`useParams\`](https://nextjs.org/docs/app/api-reference/functions/use-params)
    */
-  export const useParams = <Pathname extends Route["pathname"] = Route["pathname"]>() => RoutedQuery<Pathname>;
+  export const useParams: <Pathname extends Route["pathname"] = Route["pathname"]>() => RoutedQuery<Pathname>;
 }
 ",
   ],
@@ -951,7 +951,7 @@ declare module "next/navigation" {
    *
    * Read more: [Next.js Docs: \`usePathname\`](https://nextjs.org/docs/app/api-reference/functions/use-pathname)
    */
-  export const usePathname = () => RouteLiteral;
+  export const usePathname: () => RouteLiteral;
 
   type AppRouterInstance = Omit<NextAppRouterInstance, 'push' | 'replace' | 'href'> & {
     push(href: StaticRoute | RouteLiteral, options?: NavigateOptions): void;
@@ -996,7 +996,7 @@ declare module "next/navigation" {
    *
    * Read more: [Next.js Docs: \`useParams\`](https://nextjs.org/docs/app/api-reference/functions/use-params)
    */
-  export const useParams = <Pathname extends Route["pathname"] = Route["pathname"]>() => RoutedQuery<Pathname>;
+  export const useParams: <Pathname extends Route["pathname"] = Route["pathname"]>() => RoutedQuery<Pathname>;
 }
 ",
   ],
@@ -2284,7 +2284,7 @@ declare module "next/navigation" {
    *
    * Read more: [Next.js Docs: \`usePathname\`](https://nextjs.org/docs/app/api-reference/functions/use-pathname)
    */
-  export const usePathname = () => RouteLiteral;
+  export const usePathname: () => RouteLiteral;
 
   type AppRouterInstance = Omit<NextAppRouterInstance, 'push' | 'replace' | 'href'> & {
     push(href: StaticRoute | RouteLiteral, options?: NavigateOptions): void;
@@ -2329,7 +2329,7 @@ declare module "next/navigation" {
    *
    * Read more: [Next.js Docs: \`useParams\`](https://nextjs.org/docs/app/api-reference/functions/use-params)
    */
-  export const useParams = <Pathname extends Route["pathname"] = Route["pathname"]>() => RoutedQuery<Pathname>;
+  export const useParams: <Pathname extends Route["pathname"] = Route["pathname"]>() => RoutedQuery<Pathname>;
 }
 ",
   ],

diff --git a/packages/nextjs-routes/src/core.ts b/packages/nextjs-routes/src/core.ts
@@ -333,7 +333,7 @@ declare module "next/navigation" {
    *
    * Read more: [Next.js Docs: \`usePathname\`](https://nextjs.org/docs/app/api-reference/functions/use-pathname)
    */
-  export const usePathname = () => RouteLiteral;
+  export const usePathname: () => RouteLiteral;
 
   type AppRouterInstance = Omit<NextAppRouterInstance, 'push' | 'replace' | 'href'> & {
     push(href: StaticRoute | RouteLiteral, options?: NavigateOptions): void;
@@ -378,7 +378,7 @@ declare module "next/navigation" {
    *
    * Read more: [Next.js Docs: \`useParams\`](https://nextjs.org/docs/app/api-reference/functions/use-params)
    */
-  export const useParams = <Pathname extends Route["pathname"] = Route["pathname"]>() => RoutedQuery<Pathname>;
+  export const useParams: <Pathname extends Route["pathname"] = Route["pathname"]>() => RoutedQuery<Pathname>;
 }
 `;
   }