nuxt-typed-router 1.0.2 → 1.1.0-beta.0

package/README.md

@@ -77,16 +77,22 @@ interface ModuleOptions {
 
 # Generated files
 
-The module will create 2 files:
+The module will generate 4 files each time you modify the `pages` folder :
 
-- `__routes.ts` with the global object of the route names inside.
-- `typed-router.d.ts` containing the global typecript definitions and exports
+- `~/<outDir>/__routes.ts` with the global object of the route names inside.
+- `~/<outDir>/__useTypedRouter` Composable tu simply access your typed routes
+- `~/<outDir>/typed-router.d.ts` containing the global typecript definitions and exports
+- `~/plugins/__typed_router.ts` Plugin that will inject `$typedRouter` and `$routesList` (`@nuxt/kit` has problems registering plugin templates so this is a workaround)
 
 # Usage in Vue/Nuxt
 
+## Check out this demo and clone it! [nuxt-typed-router-demo](https://github.com/victorgarciaesgi/nuxt-typed-router-demo)
+
+<br/>
+
 ### **_Requirements_**
 
-You have to specify the output dir of the generated files in your configuration
+You can specify the output dir of the generated files in your configuration. It defaults to `<srcDir>/generated`
 
 ```ts
 import TypedRouter from 'nuxt-typed-router';
@@ -146,13 +152,16 @@ export type TypedRouteList =
   | 'index-user';
 ```
 
+> nuxt-typed-router will also create a plugin in your `<srcDir>/plugins` folder with the injected `$typedRouter` and `$routesList` helpers
+
 # Usage with `useTypedRouter` hook
 
 `useTypedRouter` is an exported composable from nuxt-typed-router. It contains a clone of `vue-router` but with stritly typed route names and params type-check
 
 ```vue
 <script lang="ts">
-import { useTypedRouter } from 'nuxt-typed-router/hook';
+// The path here is `~/generated` because I set `outDir: './generated'` in my module options
+import { useTypedRouter } from '~/generated';
 
 export default defineComponent({
   setup() {
@@ -171,7 +180,7 @@ export default defineComponent({
 </script>
 ```
 
-# Usage with `$typedRouter` injected method
+# Usage with `$typedRouter` and `$routesList` injected helpers
 
 `$typedRouter` is an injected clone of vue-router `$router`, but fully typed with all your routes.
 It's available anywhere you have access to Nuxt context
@@ -183,10 +192,10 @@ import { defineComponent } from 'vue';
 export default defineComponent({
   name: 'Index',
   setup() {
-    const { $typedRouter } = useNuxtApp();
+    const { $typedRouter, $routesList } = useNuxtApp();
 
     function navigate() {
-      $typedRouter.push({ name: 'activate' });
+      $typedRouter.push({ name: $routesList.activate });
     }
 
     return {
@@ -197,6 +206,25 @@ export default defineComponent({
 </script>
 ```
 
+# Usage outside Vue component
+
+You can import the `useTypedRouter` composable from where it's generated.
+Exemple with `pinia` store here
+
+```ts
+import pinia from 'pinia';
+import { useTypedRouter } from '~/generated';
+
+export const useFooStore = defineStore('foo', {
+  actions: {
+    bar() {
+      const { router, routes } = useTypedRouter();
+      router.push({ name: routes.index.user, params: { user: 2 } });
+    },
+  },
+});
+```
+
 ## Development
 
 1. Clone this repository

package/dist/module.json

@@ -5,5 +5,5 @@
     "nuxt": "^3.0.0",
     "bridge": false
   },
-  "version": "1.0.2"
+  "version": "1.1.0-beta.0"
 }

package/dist/module.mjs

@@ -1,4 +1,4 @@
-import { extendPages, addPluginTemplate, defineNuxtModule } from '@nuxt/kit';
+import { extendPages, defineNuxtModule } from '@nuxt/kit';
 import { fileURLToPath } from 'url';
 import chalk from 'chalk';
 import logSymbols from 'log-symbols';
@@ -192,8 +192,12 @@ function walkThoughRoutes({
 }
 
 const signatureTemplate = `/** 
-  * Generated by nuxt-typed-router. Do not modify 
-  * */`;
+  * ---------------------
+  * \u{1F697}\u{1F6A6} Generated by nuxt-typed-router. Do not modify !
+  * ---------------------
+  * */
+ 
+`;
 const staticDeclImports = `
 import type {
   NavigationFailure,
@@ -288,18 +292,11 @@ const staticDeclarations = `
       $routesList: RouteListDecl;
     }
   }
-  declare module 'nuxt-typed-router/hook' {
-    declare const useTypedRouter: () => {
-      /** Export of $router with type check */
-      router: TypedRouter,
-      /** Contains a typed dictionnary of all your route names (for syntax sugar) */
-      routes: RouteListDecl
-    };
-  }
   `;
 
 function createRuntimePluginFile(routesDeclTemplate) {
   return `
+  ${signatureTemplate}
   import { defineNuxtPlugin } from '#app';
 
   export default defineNuxtPlugin((nuxtApp) => {
@@ -307,7 +304,7 @@ function createRuntimePluginFile(routesDeclTemplate) {
 
     return {
       provide: {
-        typedRouter: nuxtApp.vueApp.$router,
+        typedRouter: nuxtApp.$router,
         routesList,
       },
     };
@@ -316,17 +313,22 @@ function createRuntimePluginFile(routesDeclTemplate) {
 }
 function createRuntimeHookFile(routesDeclTemplate) {
   return `
+  ${signatureTemplate}
   import { getCurrentInstance } from 'vue';
+  import { useNuxtApp } from '#app';
 
-  function useNuxtApp() {
-    const vm = getCurrentInstance();
-    if (!vm) {
-      throw new Error('nuxt instance unavailable');
-    }
-    return vm.appContext.app.$nuxt;
-  }
-
-  export const useTypedRouter = () => {
+  /** Returns instances of $typedRouter and $routesList fully typed to use in your components or your Vuex/Pinia store
+   * 
+   * @exemple
+   * 
+   * const { router, routes } = useTypedRouter();
+   */
+  export const useTypedRouter = (): {
+    /** Export of $router with type check */
+    router: TypedRouter,
+    /** Contains a typed dictionnary of all your route names (for syntax sugar) */
+    routes: RouteListDecl
+  } => {
     const { $router } = useNuxtApp();
 
     const routesList = ${routesDeclTemplate};
@@ -334,11 +336,18 @@ function createRuntimeHookFile(routesDeclTemplate) {
     return {
       router: $router,
       routes: routesList,
-    };
+    } as any;
   };
 
   `;
 }
+function createRuntimeIndexFile() {
+  return `
+  ${signatureTemplate}
+  export * from './__routes';
+  export * from './__useTypedRouter';
+  `;
+}
 function createRuntimeRoutesFile({
   routesList,
   routesObjectTemplate,
@@ -380,27 +389,28 @@ function createTypedRouteParamsExport(routesParams) {
 }
 
 const __dirname = dirname(fileURLToPath(import.meta.url));
-function routeHook(outDir, routesObjectName) {
+function routeHook(outDir, routesObjectName, srcDir, nuxt) {
   try {
     extendPages(async (routes) => {
-      const { routesDeclTemplate, routesList, routesObjectTemplate, routesParams } = constructRouteMap(routes);
-      const pluginName = "typed-router.mjs";
-      const runtimeDir = resolve(__dirname, process.env.NUXT_BUILD_TYPE === "stub" ? "../../dist/runtime" : "./runtime");
-      const pluginPath = resolve(runtimeDir, pluginName);
-      await Promise.all([
-        saveRouteFiles(runtimeDir, "useTypedRouter.mjs", createRuntimeHookFile(routesDeclTemplate)),
-        saveRouteFiles(runtimeDir, pluginName, createRuntimePluginFile(routesDeclTemplate))
-      ]);
-      addPluginTemplate({
-        src: pluginPath,
-        filename: pluginName,
-        options: {
-          routesList: "test"
-        }
-      });
-      await saveRouteFiles(outDir, `__routes.ts`, createRuntimeRoutesFile({ routesList, routesObjectTemplate, routesObjectName }));
-      await saveRouteFiles(outDir, `typed-router.d.ts`, createDeclarationRoutesFile({ routesDeclTemplate, routesList, routesParams }));
-      console.log(logSymbols.success, `[typed-router] Routes definitions generated`);
+      if (routes.length) {
+        const { routesDeclTemplate, routesList, routesObjectTemplate, routesParams } = constructRouteMap(routes);
+        const pluginName = "__typed-router.ts";
+        const runtimeDir = resolve(__dirname, process.env.NUXT_BUILD_TYPE === "stub" ? "../../dist/runtime" : "./runtime");
+        const pluginPath = resolve(runtimeDir, pluginName);
+        nuxt.hook("build:done", async () => {
+          const pluginFolder = `${srcDir}/plugins`;
+          await saveRouteFiles(pluginFolder, pluginName, createRuntimePluginFile(routesDeclTemplate));
+        });
+        await Promise.all([
+          saveRouteFiles(outDir, "__useTypedRouter.ts", createRuntimeHookFile(routesDeclTemplate)),
+          saveRouteFiles(outDir, `__routes.ts`, createRuntimeRoutesFile({ routesList, routesObjectTemplate, routesObjectName })),
+          saveRouteFiles(outDir, `typed-router.d.ts`, createDeclarationRoutesFile({ routesDeclTemplate, routesList, routesParams })),
+          saveRouteFiles(outDir, "index.ts", createRuntimeIndexFile())
+        ]);
+        console.log(logSymbols.success, `[typed-router] Routes definitions generated`);
+      } else {
+        console.log(logSymbols.warning, chalk.yellow(`[typed-router] No routes defined. Check if your ${chalk.underline(chalk.bold("pages"))} folder exists and remove ${chalk.underline(chalk.bold("app.vue"))}`));
+      }
     });
   } catch (e) {
     console.error(chalk.red("Error while generating routes definitions model"), "\n" + e);
@@ -418,10 +428,10 @@ const module = defineNuxtModule({
     stripAtFromName: false
   },
   setup(moduleOptions, nuxt) {
-    const { outDir = `${nuxt.options.srcDir}/generated`, routesObjectName } = moduleOptions;
-    nuxt.hook("pages:extend", () => routeHook(outDir, routesObjectName));
-    nuxt.hook("build:extendRoutes", () => routeHook(outDir, routesObjectName));
-    routeHook(outDir, routesObjectName);
+    const srcDir = nuxt.options.srcDir;
+    const { outDir = `${srcDir}/generated`, routesObjectName } = moduleOptions;
+    nuxt.hook("pages:extend", () => routeHook(outDir, routesObjectName, srcDir, nuxt));
+    routeHook(outDir, routesObjectName, srcDir, nuxt);
   }
 });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-typed-router",
-  "version": "1.0.2",
+  "version": "1.1.0-beta.0",
   "description": "Provide autocompletion for pages route names generated by Nuxt router",
   "type": "module",
   "scripts": {
@@ -17,18 +17,13 @@
     ".": {
       "import": "./dist/module.mjs",
       "require": "./dist/module.cjs"
-    },
-    "./hook": {
-      "import": "./hook.mjs"
     }
   },
   "main": "./dist/module.cjs",
   "types": "./main.d.ts",
   "files": [
     "dist",
-    "main.d.ts",
-    "hook.mjs",
-    "hook.d.ts"
+    "main.d.ts"
   ],
   "publishConfig": {
     "access": "public"

package/dist/runtime/index.d.ts

@@ -1 +0,0 @@
-export { useTypedRouter } from './useTypedRouter';

package/dist/runtime/index.mjs

@@ -1 +0,0 @@
-export { useTypedRouter } from "./useTypedRouter.mjs";

package/dist/runtime/typed-router.d.ts

@@ -1,34 +0,0 @@
-import { defineNuxtPlugin } from '#app';
-
-export default defineNuxtPlugin((nuxtApp) => {
-  const routesList = {
-    activate: 'activate',
-    index: 'index',
-    childOne: {
-      childOneChildOneSubOne: 'parent-child-one-child-one-sub-one',
-      user: { index: 'parent-child-one-child-one-sub-one-user' },
-      childOneChildOneSubTwo: 'parent-child-one-child-one-sub-two',
-      index: 'parent-child-one',
-    },
-    childTwo: {
-      childTwoId: 'parent-child-two-id',
-      childTwoChildOneSubOne: 'parent-child-two-child-one-sub-one',
-      index: 'parent-child-two',
-      profile: {
-        id: {
-          slug: { index: 'parent-child-two-profile-id-slug' },
-          index: 'parent-child-two-profile-id',
-        },
-        index: 'parent-child-two-profile',
-      },
-    },
-    rootPage: 'rootPage',
-  };
-
-  return {
-    provide: {
-      typedRouter: nuxtApp.vueApp.$router,
-      routesList,
-    },
-  };
-});

package/dist/runtime/typed-router.mjs

@@ -1,34 +0,0 @@
-import { defineNuxtPlugin } from '#app';
-
-export default defineNuxtPlugin((nuxtApp) => {
-  const routesList = {
-    activate: 'activate',
-    index: 'index',
-    childOne: {
-      childOneChildOneSubOne: 'parent-child-one-child-one-sub-one',
-      user: { index: 'parent-child-one-child-one-sub-one-user' },
-      childOneChildOneSubTwo: 'parent-child-one-child-one-sub-two',
-      index: 'parent-child-one',
-    },
-    childTwo: {
-      childTwoId: 'parent-child-two-id',
-      childTwoChildOneSubOne: 'parent-child-two-child-one-sub-one',
-      index: 'parent-child-two',
-      profile: {
-        id: {
-          slug: { index: 'parent-child-two-profile-id-slug' },
-          index: 'parent-child-two-profile-id',
-        },
-        index: 'parent-child-two-profile',
-      },
-    },
-    rootPage: 'rootPage',
-  };
-
-  return {
-    provide: {
-      typedRouter: nuxtApp.vueApp.$router,
-      routesList,
-    },
-  };
-});

package/dist/runtime/useTypedRouter.d.ts

@@ -1,42 +0,0 @@
-import { getCurrentInstance } from 'vue';
-
-function useNuxtApp() {
-  const vm = getCurrentInstance();
-  if (!vm) {
-    throw new Error('nuxt instance unavailable');
-  }
-  return vm.appContext.app.$nuxt;
-}
-
-export const useTypedRouter = () => {
-  const { $router } = useNuxtApp();
-
-  const routesList = {
-    activate: 'activate',
-    index: 'index',
-    childOne: {
-      childOneChildOneSubOne: 'parent-child-one-child-one-sub-one',
-      user: { index: 'parent-child-one-child-one-sub-one-user' },
-      childOneChildOneSubTwo: 'parent-child-one-child-one-sub-two',
-      index: 'parent-child-one',
-    },
-    childTwo: {
-      childTwoId: 'parent-child-two-id',
-      childTwoChildOneSubOne: 'parent-child-two-child-one-sub-one',
-      index: 'parent-child-two',
-      profile: {
-        id: {
-          slug: { index: 'parent-child-two-profile-id-slug' },
-          index: 'parent-child-two-profile-id',
-        },
-        index: 'parent-child-two-profile',
-      },
-    },
-    rootPage: 'rootPage',
-  };
-
-  return {
-    router: $router,
-    routes: routesList,
-  };
-};

package/dist/runtime/useTypedRouter.mjs

@@ -1,42 +0,0 @@
-import { getCurrentInstance } from 'vue';
-
-function useNuxtApp() {
-  const vm = getCurrentInstance();
-  if (!vm) {
-    throw new Error('nuxt instance unavailable');
-  }
-  return vm.appContext.app.$nuxt;
-}
-
-export const useTypedRouter = () => {
-  const { $router } = useNuxtApp();
-
-  const routesList = {
-    activate: 'activate',
-    index: 'index',
-    childOne: {
-      childOneChildOneSubOne: 'parent-child-one-child-one-sub-one',
-      user: { index: 'parent-child-one-child-one-sub-one-user' },
-      childOneChildOneSubTwo: 'parent-child-one-child-one-sub-two',
-      index: 'parent-child-one',
-    },
-    childTwo: {
-      childTwoId: 'parent-child-two-id',
-      childTwoChildOneSubOne: 'parent-child-two-child-one-sub-one',
-      index: 'parent-child-two',
-      profile: {
-        id: {
-          slug: { index: 'parent-child-two-profile-id-slug' },
-          index: 'parent-child-two-profile-id',
-        },
-        index: 'parent-child-two-profile',
-      },
-    },
-    rootPage: 'rootPage',
-  };
-
-  return {
-    router: $router,
-    routes: routesList,
-  };
-};

package/hook.d.ts

@@ -1,4 +0,0 @@
-/** @deprecated Do not import or use. Dummy export to fool Typescript into thinking it's a module */
-declare const doNotImportItsToFoolTypescript = 'foo';
-
-export { doNotImportItsToFoolTypescript };

package/hook.mjs

@@ -1 +0,0 @@
-export { useTypedRouter } from './dist/runtime/useTypedRouter.mjs';