Updated types

victorgarciaesgi · Dec 20, 2022 · f86720f · f86720f
1 parent 5d02f7f
commit f86720f
Show file tree

Hide file tree

Showing 8 changed files with 26 additions and 46 deletions.
diff --git a/playground/generated/typed-router.d.ts b/playground/generated/typed-router.d.ts
@@ -73,7 +73,7 @@ type TypedRouteLocationRaw<T extends TypedRouteList> = RouteQueryAndHash &
   TypedLocationAsRelativeRaw<T> &
   RouteLocationOptions;
 
-export interface TypedRouter {
+interface _TypedRouter {
   /**
    * Remove an existing route by its name.
    *
@@ -121,16 +121,7 @@ export interface TypedRouter {
   ): Promise<NavigationFailure | void | undefined>;
 }
 
-declare module 'nuxt/dist/app/nuxt' {
-  export interface NuxtApp {
-    $typedRouter: TypedRouter;
-    $routesList: RouteListDecl;
-  }
-}
-
-declare module '@vue/runtime-core' {
-  interface ComponentCustomProperties {
-    $typedRouter: TypedRouter;
-    $routesList: RouteListDecl;
-  }
+export interface TypedRouter extends _TypedRouter {}
+declare global {
+  export interface TypedRouter extends _TypedRouter {}
 }
diff --git a/playground/pages/index.vue b/playground/pages/index.vue
@@ -9,6 +9,7 @@ import { useTypedRouter } from '../generated';
 import { callOutsideComponent } from '../store';
 
 const { router, routes } = useTypedRouter();
+const { $routesList, $typedRouter } = useNuxtApp();
 function navigate() {
   // console.log($typedRouter, $routesList);
   // router.push({ name: 'activate' });

diff --git a/playground/plugins/__typed-router.ts b/playground/plugins/__typed-router.ts
@@ -6,7 +6,8 @@
 
 import { defineNuxtPlugin } from '#app';
 
-export default defineNuxtPlugin((nuxtApp) => {
+export default defineNuxtPlugin(() => {
+  const router = useRouter();
   const routesList = {
     activate: 'activate',
     index: 'index',
@@ -33,7 +34,7 @@ export default defineNuxtPlugin((nuxtApp) => {
 
   return {
     provide: {
-      typedRouter: nuxtApp.$router,
+      typedRouter: router as TypedRouter,
       routesList,
     },
   };

diff --git a/playground/tsconfig.json b/playground/tsconfig.json
@@ -0,0 +1,3 @@
+{
+  "extends": "./.nuxt/tsconfig.json"
+}
diff --git a/src/generators/output.generator.ts b/src/generators/output.generator.ts
@@ -6,12 +6,13 @@ export function createRuntimePluginFile(routesDeclTemplate: string): string {
   ${signatureTemplate}
   import { defineNuxtPlugin } from '#app';
 
-  export default defineNuxtPlugin((nuxtApp) => {
+  export default defineNuxtPlugin(() => {
+    const router = useRouter();
     const routesList = ${routesDeclTemplate};
 
     return {
       provide: {
-        typedRouter: nuxtApp.$router,
+        typedRouter: router as TypedRouter,
         routesList,
       },
     };

diff --git a/src/generators/output.templates.ts b/src/generators/output.templates.ts
@@ -31,7 +31,7 @@ export const staticDeclarations = `
     TypedLocationAsRelativeRaw<T> &
     RouteLocationOptions;
   
-  export interface TypedRouter {
+  interface _TypedRouter {
     /**
      * Remove an existing route by its name.
      *
@@ -78,18 +78,9 @@ export const staticDeclarations = `
       to: TypedRouteLocationRaw<T>
     ): Promise<NavigationFailure | void | undefined>;
   }
-  
-  declare module 'nuxt/dist/app/nuxt' {
-    export interface NuxtApp {
-      $typedRouter: TypedRouter;
-      $routesList: RouteListDecl;
-    }
-  }
 
-  declare module '@vue/runtime-core' {
-    interface ComponentCustomProperties {
-      $typedRouter: TypedRouter;
-      $routesList: RouteListDecl;
-    }
+  export interface TypedRouter extends _TypedRouter {}
+  declare global {
+    export interface TypedRouter extends _TypedRouter {}
   }
   `;
diff --git a/test/tsconfig.json b/test/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig.json",
+  "extends": "../tsconfig.json",
   "compilerOptions": {
     "types": ["node", "vitest/globals"]
   },

diff --git a/test/unit/__snapshots__/root.spec.ts.snap b/test/unit/__snapshots__/root.spec.ts.snap
@@ -124,7 +124,7 @@ type TypedRouteLocationRaw<T extends TypedRouteList> = RouteQueryAndHash &
   TypedLocationAsRelativeRaw<T> &
   RouteLocationOptions;
 
-export interface TypedRouter {
+interface _TypedRouter {
   /**
    * Remove an existing route by its name.
    *
@@ -172,18 +172,9 @@ export interface TypedRouter {
   ): Promise<NavigationFailure | void | undefined>;
 }
 
-declare module 'nuxt/dist/app/nuxt' {
-  export interface NuxtApp {
-    $typedRouter: TypedRouter;
-    $routesList: RouteListDecl;
-  }
-}
-
-declare module '@vue/runtime-core' {
-  interface ComponentCustomProperties {
-    $typedRouter: TypedRouter;
-    $routesList: RouteListDecl;
-  }
+export interface TypedRouter extends _TypedRouter {}
+declare global {
+  export interface TypedRouter extends _TypedRouter {}
 }
 "
 `;
@@ -255,7 +246,8 @@ exports[`Init route file > should generate to correct tree for the pages folder
 
 import { defineNuxtPlugin } from '#app';
 
-export default defineNuxtPlugin((nuxtApp) => {
+export default defineNuxtPlugin(() => {
+  const router = useRouter();
   const routesList = {
     activate: 'activate',
     index: 'index',
@@ -282,7 +274,7 @@ export default defineNuxtPlugin((nuxtApp) => {
 
   return {
     provide: {
-      typedRouter: nuxtApp.$router,
+      typedRouter: router as TypedRouter,
       routesList,
     },
   };