nuxt-typed-router 2.1.2 → 2.1.4

package/README.md

@@ -19,11 +19,14 @@
 ## Provide a type safe router to Nuxt with auto-generated typed definitions for route names and autocompletion for route params
 
 - `NuxtLink` route autocomplete and params type-check 
-- `useRouter` and `useRoute`  route autocomplete and params type-check
+- `useRouter`, `useRoute` and `navigateTo` route autocomplete and params type-check
 - Supports optional params and catchAll routes
 - Infer route params based on route name
 - Supports routes defined in `config.extendRoutes`
 
+> ⚠️ Since `v2.1.x`, `useTypedRouter` and `useTypedRoute` are no longer exported.   
+The package can now override types from `useRouter`, `useRoute` and `navigateTo`
+
 <br/>
 
 <br/>
@@ -33,6 +36,8 @@
 <br/>
 
 
+
+
 # Documentation
 
 [![Documentation](https://github.com/victorgarciaesgi/nuxt-typed-router/blob/master/.github/images/redirectDoc.svg?raw=true)](https://nuxt-typed-router.vercel.app/)

package/dist/module.json

@@ -5,5 +5,5 @@
     "nuxt": "^3.0.0-rc.1",
     "bridge": false
   },
-  "version": "2.1.2"
+  "version": "2.1.4"
 }

package/dist/module.mjs

@@ -29,11 +29,13 @@ function createDeclarationRoutesFile(autoImport) {
     import type { TypedRouteNamedMapper } from './__routes';
     import { useRoute as _useRoute } from './__useTypedRoute';
     import { useRouter as _useRouter } from './__useTypedRouter';
+    import { navigateTo as _navigateTo } from './__utils';
 
     declare global {
  
       ${autoImport ? `const useRoute: typeof _useRoute;
-         const useRouter: typeof _useRouter;` : ""}
+            const useRouter: typeof _useRouter;
+            const navigateTo: typeof _navigateTo;` : ""}
     }
     
     type TypedNuxtLinkProps = Omit<NuxtLinkProps, 'to'> & {
@@ -72,14 +74,15 @@ function createRuntimeIndexFile() {
   export type { TypedRouteList, TypedRouteNamedMapper, TypedRouteParams } from './__routes';
   export {useRouter} from './__useTypedRouter';
   export {useRoute} from './__useTypedRoute';
-  export type {TypedRoute, TypedRouter, TypedNamedRoute } from './__router'
+  export type {TypedRoute, TypedRouter, TypedNamedRoute } from './__router';
+  export * from './__utils';
   `;
 }
 
 function createRuntimePluginFile(routesDeclTemplate) {
   return `
   ${watermarkTemplate}
-  import { defineNuxtPlugin } from '#app';
+  import { defineNuxtPlugin, useRouter, useRoute } from '#app';
   import {TypedRouter, TypedRoute} from '@typed-router';
 
   export default defineNuxtPlugin(() => {
@@ -274,7 +277,13 @@ function createRuntimeRouterTypes() {
     name?: T;
   } & ([TypedRouteParams[T]] extends [never] ? {} : { params: TypedRouteParams[T] });
   
-  type TypedRouteLocationRaw = RouteQueryAndHash & TypedRouteNamedMapper & RouteLocationOptions;
+  export type TypedNamedRouteLocation<T extends TypedRouteList> =
+  | (Omit<Exclude<RouteLocationRaw, string>, 'name' | 'params'> & TypedLocationAsRelativeRaw<T>)
+  | string;
+  
+  type TypedRouteLocationRaw =
+    | (Omit<Exclude<RouteLocationRaw, string>, 'name' | 'params'> & TypedRouteNamedMapper)
+    | string;
   
   type _TypedRoute = Omit<RouteLocationNormalizedLoaded, 'name' | 'params'> &
     ResolvedTypedRouteNamedMapper;
@@ -337,6 +346,23 @@ function createRuntimeRouterTypes() {
   `;
 }
 
+function createRuntimeNavigateToFunction() {
+  return `
+    ${watermarkTemplate}
+    import { navigateTo as defaultNavigateTo } from '#app';
+    import { NavigateToOptions } from 'nuxt/dist/app/composables/router';
+    import { NavigationFailure } from 'vue-router';
+    import type { TypedNamedRouteLocation } from './__router';
+    import { TypedRouteList } from './__routes';
+
+    export const navigateTo: <T extends TypedRouteList>(
+      to: TypedNamedRouteLocation<T>,
+      options?: NavigateToOptions
+    ) => Promise<void | NavigationFailure | TypedNamedRoute<T>> = defaultNavigateTo as any;
+
+  `;
+}
+
 const { resolveConfig, format } = prettier;
 const defaultPrettierOptions = {
   printWidth: 100,
@@ -398,21 +424,20 @@ async function writeFile(path, content) {
   }
 }
 
-function handlePluginFileSave({
-  nuxt,
-  rootDir,
-  routesDeclTemplate
-}) {
+function handlePluginFileSave({ nuxt, routesDeclTemplate }) {
   const pluginName = "__typed-router.ts";
-  nuxt.hook("build:done", async () => {
-    const pluginFolder = `${rootDir}/plugins`;
+  const srcDir = nuxt.options.srcDir;
+  async function savePlugin() {
+    const pluginFolder = `${srcDir}/plugins`;
     await processPathAndWriteFile({
       outDir: pluginFolder,
-      rootDir,
+      rootDir: srcDir,
       fileName: pluginName,
       content: createRuntimePluginFile(routesDeclTemplate)
     });
-  });
+  }
+  nuxt.hook("build:done", savePlugin);
+  nuxt.hook("prepare:types", savePlugin);
 }
 
 let previousGeneratedRoutes = "";
@@ -439,6 +464,10 @@ async function saveGeneratedFiles({
         routesParams
       })
     },
+    {
+      fileName: "__utils.ts",
+      content: createRuntimeNavigateToFunction()
+    },
     {
       fileName: `__router.d.ts`,
       content: createRuntimeRouterTypes()
@@ -617,36 +646,58 @@ function startGenerator({ output, routesConfig }) {
   output.routesDeclTemplate += "}";
 }
 
-function createTypedRouter({ plugin, nuxt }) {
+let hasLoggedNoPages = false;
+let hasRoutesDefined = false;
+async function createTypedRouter({
+  plugin,
+  nuxt,
+  routesConfig,
+  isHookCall = false
+}) {
   try {
     const rootDir = nuxt.options.rootDir;
     const autoImport = nuxt.options.imports.autoImport ?? true;
+    if (!isHookCall) {
+      if (routesConfig) {
+        await nuxt.callHook("pages:extend", routesConfig);
+        return;
+      }
+      nuxt.hook("pages:extend", (routesConfig2) => {
+        createTypedRouter({ nuxt, plugin, routesConfig: routesConfig2, isHookCall: true });
+      });
+      nuxt.hook("modules:done", () => {
+        createTypedRouter({ nuxt, plugin, isHookCall: true });
+      });
+      return;
+    }
     extendPages(async (routes) => {
-      if (routes.length) {
-        const outputData = constructRouteMap(routes);
-        if (plugin) {
-          handlePluginFileSave({
-            nuxt,
-            routesDeclTemplate: outputData.routesDeclTemplate,
-            rootDir
-          });
-        }
-        await saveGeneratedFiles({
-          autoImport,
-          rootDir,
-          outputData
+      hasRoutesDefined = true;
+      const outputData = constructRouteMap(routes);
+      if (plugin) {
+        handlePluginFileSave({
+          nuxt,
+          routesDeclTemplate: outputData.routesDeclTemplate
         });
-      } else {
+      }
+      await saveGeneratedFiles({
+        autoImport,
+        rootDir,
+        outputData
+      });
+    });
+    setTimeout(() => {
+      if (!hasRoutesDefined && !hasLoggedNoPages) {
+        hasLoggedNoPages = true;
         console.log(
           logSymbols.warning,
           chalk.yellow(
-            `[typed-router] No routes defined. Check if your ${chalk.underline(
+            `\u{1F6A6} No routes defined. Check if your ${chalk.underline(
               chalk.bold("pages")
-            )} folder exists and remove ${chalk.underline(chalk.bold("app.vue"))}`
+            )} folder exists`
           )
         );
       }
-    });
+    }, 3e3);
   } catch (e) {
     console.error(chalk.red("Error while generating routes definitions model"), "\n" + e);
   }
@@ -673,8 +724,7 @@ const module = defineNuxtModule({
       include: ["./typed-router/typed-router.d.ts"]
     };
     const typedRouterOptions = { nuxt, plugin };
-    nuxt.hook("pages:extend", () => createTypedRouter(typedRouterOptions));
-    createTypedRouter(typedRouterOptions);
+    createTypedRouter({ ...typedRouterOptions });
   }
 });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-typed-router",
-  "version": "2.1.2",
+  "version": "2.1.4",
   "description": "Provide autocompletion for pages route names generated by Nuxt router",
   "type": "module",
   "main": "./dist/module.cjs",
@@ -21,13 +21,14 @@
     "dev:build": "nuxi build playground",
     "dev:prepare": "nuxt-module-build --stub && nuxi prepare playground && pnpm run test:prepare-fixtures",
     "build:test": "cross-env NUXT_BUILD_TYPE=stub pnpm run prepack && pnpm run dev:build",
-    "test:prepare-fixtures": "nuxi prepare test/fixtures/simple",
+    "test:prepare-fixtures": "nuxi prepare test/fixtures/simple && nuxi generate test/fixtures/complex",
     "test:fixtures": " vitest run --dir test",
-    "test:types": "pnpm run test:vue && vitest typecheck --run --dir test",
+    "test:types": "pnpm run typecheck && pnpm run test:vue && vitest typecheck --run --dir test",
     "test:vue": "vue-tsc -p test/fixtures/simple/tsconfig.json --noEmit && vue-tsc -p test/fixtures/complex/tsconfig.json --noEmit",
     "test": "pnpm run dev:prepare && pnpm run test:fixtures && pnpm run test:types",
     "docs:dev": "cd docs && pnpm run dev",
-    "docs:build": "npm run dev:prepare && cd docs && nuxi generate"
+    "docs:build": "npm run dev:prepare && cd docs && nuxi generate",
+    "typecheck": "tsc --noEmit"
   },
   "publishConfig": {
     "access": "public"
@@ -61,7 +62,7 @@
     "lodash-es": "^4.17.21",
     "log-symbols": "^5.1.0",
     "mkdirp": "^1.0.4",
-    "pathe": "1.0.0",
+    "pathe": "1.1.0",
     "prettier": "2.8.3"
   },
   "devDependencies": {
@@ -78,8 +79,9 @@
     "eslint-config-prettier": "^8.6.0",
     "eslint-plugin-vue": "^9.9.0",
     "nuxt": "3.0.0",
+    "playwright": "1.29.2",
     "typescript": "^4.9.4",
-    "vitest": "^0.27.2",
+    "vitest": "^0.28.1",
     "vue-router": "^4.1.6",
     "vue-tsc": "^1.0.24"
   }