nuxt-typed-router 1.0.4 → 1.1.0

package/README.md

@@ -46,7 +46,7 @@ npm install -D nuxt-typed-router@legacy
 
 # Configuration
 
-First, register the module in the `nuxt.config.[js|ts]`
+First, register the module in the `nuxt.config.ts`
 
 ```ts
 import TypedRouter from 'nuxt-typed-router';
@@ -77,10 +77,12 @@ 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.ts` 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
 
@@ -122,7 +124,7 @@ Given this structure
         │   └── login.vue
         └── ...
 
-The generated file will look like this
+The generated route list will look like this
 
 ```ts
 export const routerPagesNames = {
@@ -158,7 +160,8 @@ export type TypedRouteList =
 
 ```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() {
@@ -210,7 +213,7 @@ Exemple with `pinia` store here
 
 ```ts
 import pinia from 'pinia';
-import { useTypedRouter } from 'nuxt-typed-router/hook';
+import { useTypedRouter } from '~/generated';
 
 export const useFooStore = defineStore('foo', {
   actions: {

package/dist/module.json

@@ -5,5 +5,5 @@
     "nuxt": "^3.0.0",
     "bridge": false
   },
-  "version": "1.0.4"
+  "version": "1.1.0"
 }

package/dist/module.mjs

@@ -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,
@@ -227,7 +231,7 @@ const staticDeclarations = `
     TypedLocationAsRelativeRaw<T> &
     RouteLocationOptions;
   
-  interface TypedRouter {
+  export interface TypedRouter {
     /**
      * Remove an existing route by its name.
      *
@@ -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) => {
@@ -316,10 +313,24 @@ function createRuntimePluginFile(routesDeclTemplate) {
 }
 function createRuntimeHookFile(routesDeclTemplate) {
   return `
-  import { getCurrentInstance } from 'vue';
+  ${signatureTemplate}
   import { useNuxtApp } from '#app';
+  import { TypedRouter, RouteListDecl } from './typed-router';
 
-  export const useTypedRouter = () => {
+  /** Returns instances of $typedRouter and $routesList fully typed to use in your components or your Vuex/Pinia store
+   * 
+   * @exemple
+   * 
+   * \`\`\`ts
+   * 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};
@@ -327,11 +338,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,
@@ -385,9 +403,12 @@ function routeHook(outDir, routesObjectName, srcDir, nuxt) {
           const pluginFolder = `${srcDir}/plugins`;
           await saveRouteFiles(pluginFolder, pluginName, createRuntimePluginFile(routesDeclTemplate));
         });
-        await saveRouteFiles(runtimeDir, "useTypedRouter.mjs", createRuntimeHookFile(routesDeclTemplate));
-        await saveRouteFiles(outDir, `__routes.ts`, createRuntimeRoutesFile({ routesList, routesObjectTemplate, routesObjectName }));
-        await saveRouteFiles(outDir, `typed-router.d.ts`, createDeclarationRoutesFile({ routesDeclTemplate, routesList, routesParams }));
+        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"))}`));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-typed-router",
-  "version": "1.0.4",
+  "version": "1.1.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/typed-router.d.ts

@@ -1,12 +0,0 @@
-import { defineNuxtPlugin } from '#app';
-
-export default defineNuxtPlugin((nuxtApp) => {
-  const routesList = {};
-
-  return {
-    provide: {
-      typedRouter: nuxtApp.$router,
-      routesList,
-    },
-  };
-});

package/dist/runtime/typed-router.mjs

@@ -1,12 +0,0 @@
-import { defineNuxtPlugin } from '#app';
-
-export default defineNuxtPlugin((nuxtApp) => {
-  const routesList = {};
-
-  return {
-    provide: {
-      typedRouter: nuxtApp.$router,
-      routesList,
-    },
-  };
-});

package/dist/runtime/useTypedRouter.d.ts

@@ -1,35 +0,0 @@
-import { getCurrentInstance } from 'vue';
-import { useNuxtApp } from '#app';
-
-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,35 +0,0 @@
-import { getCurrentInstance } from 'vue';
-import { useNuxtApp } from '#app';
-
-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';