nuxt-typed-router 2.1.0-beta.0 → 2.1.0-beta.2

package/README.md

@@ -18,11 +18,11 @@
 
 ## Provide a type safe router to Nuxt with auto-generated typed definitions for route names and autocompletion for route params
 
-- Automaticaly provides types check and autocomplete to `NuxtLink`
-- Exports a `useTypedRouter` and `useTypedRoute` composable
-- Supports routes defined in `config.extendRoutes`
-- Infer route params based on route name
-- Provide global `$typedRouter` util
+- Provides types check and autocomplete to `NuxtLink`
+  - Provides types check for `useRouter` and `useRoute` 
+  - Supports routes defined in `config.extendRoutes`
+  - Supports optional params and catchAll routes
+  - Infer route params based on route name
 
 <br/>
 
@@ -35,7 +35,7 @@
 
 # Documentation
 
-[![Open in StackBlitz](https://github.com/victorgarciaesgi/nuxt-typed-router/blob/master/.github/images/redirectDoc.svg?raw=true)](https://nuxt-typed-router.vercel.app/)
+[![Documentation](https://github.com/victorgarciaesgi/nuxt-typed-router/blob/master/.github/images/redirectDoc.svg?raw=true)](https://nuxt-typed-router.vercel.app/)
 
 # Play with it
 [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/edit/github-7e4xvw?file=store/testRouter.ts)

package/dist/module.json

@@ -5,5 +5,5 @@
     "nuxt": "^3.0.0-rc.1",
     "bridge": false
   },
-  "version": "2.1.0-beta.0"
+  "version": "2.1.0-beta.2"
 }

package/dist/module.mjs

@@ -30,129 +30,6 @@ import {useTypedRoute} from './__useTypedRoute';
 import {useTypedRouter} from './__useTypedRouter';
 `;
 
-const staticTypeUtils = `
-// Type utils
-type ExtractRequiredParameters<T extends Record<string, any>> = Pick<
-  T,
-  { [K in keyof T]: undefined extends T[K] ? never : K }[keyof T]
->;
-
-type HasOneRequiredParameter<T extends TypedRouteList> = [TypedRouteParams[T]] extends [never]
-  ? false
-  : [keyof ExtractRequiredParameters<TypedRouteParams[T]>] extends [undefined]
-  ? false
-  : true;
-
-type TypedLocationAsRelativeRaw<T extends TypedRouteList> = {
-  name?: T;
-} & ([TypedRouteParams[T]] extends [never]
-  ? {}
-  : HasOneRequiredParameter<T> extends false
-  ? { params?: TypedRouteParams[T] }
-  : { params: TypedRouteParams[T] });
-
-type ResolvedTypedLocationAsRelativeRaw<T extends TypedRouteList> = {
-  name?: T;
-} & ([TypedRouteParams[T]] extends [never] ? {} : { params: TypedRouteParams[T] });
-
-type TypedRouteLocationRaw = RouteQueryAndHash & TypedRouteNamedMapper & RouteLocationOptions;
-
-type _TypedRoute = Omit<RouteLocationNormalizedLoaded, 'name' | 'params'> &
-  ResolvedTypedRouteNamedMapper;
-type _TypedNamedRoute<T extends TypedRouteList> = Omit<
-  RouteLocationNormalizedLoaded,
-  'name' | 'params'
-> &
-  ResolvedTypedLocationAsRelativeRaw<T>;
-
-/** Augmented Router interface */
-interface _TypedRouter
-  extends Omit<Router, 'removeRoute' | 'hasRoute' | 'resolve' | 'push' | 'replace', 'currentRoute'> {
-  readonly currentRoute: _TypedRoute;
-  /**
-   * Remove an existing route by its name.
-   *
-   * @param name - Name of the route to remove
-   */
-  removeRoute(name: TypedRouteList): void;
-  /**
-   * Checks if a route with a given name exists
-   *
-   * @param name - Name of the route to check
-   */
-  hasRoute(name: TypedRouteList): boolean;
-  /**
-   * Returns the {@link RouteLocation | normalized version} of a
-   * {@link RouteLocationRaw | route location}. Also includes an \`href\` property
-   * that includes any existing \`base\`. By default the \`currentLocation\` used is
-   * \`route.currentRoute\` and should only be overriden in advanced use cases.
-   *
-   * @param to - Raw route location to resolve
-   * @param currentLocation - Optional current location to resolve against
-   */
-  resolve(
-    to: TypedRouteLocationRaw,
-    currentLocation?: RouteLocationNormalizedLoaded
-  ): RouteLocation & {
-    href: string;
-  };
-  /**
-   * Programmatically navigate to a new URL by pushing an entry in the history
-   * stack.
-   *
-   * @param to - Route location to navigate to
-   */
-  push(to: TypedRouteLocationRaw): Promise<NavigationFailure | void | undefined>;
-  /**
-   * Programmatically navigate to a new URL by replacing the current entry in
-   * the history stack.
-   *
-   * @param to - Route location to navigate to
-   */
-  replace(to: TypedRouteLocationRaw): Promise<NavigationFailure | void | undefined>;
-}
-
-export interface TypedRouter extends _TypedRouter {}
-export type TypedRoute = _TypedRoute;
-export type TypedNamedRoute<T extends TypedRouteList> = _TypedNamedRoute<T>;
-
-declare global {
-  export interface TypedRouter extends _TypedRouter {}
-  export type TypedRoute = _TypedRoute;
-  export type TypedNamedRoute<T extends TypedRouteList> = _TypedNamedRoute<T>;
-
-  const useRoute: typeof useTypedRoute;
-  const useRouter: typeof useTypedRouter;
-}
-
-type TypedNuxtLinkProps = Omit<NuxtLinkProps, 'to'> & {
-  to: string | Omit<Exclude<RouteLocationRaw, string>, 'name'> & TypedRouteNamedMapper;
-};
-
-type _NuxtLink = DefineComponent<
-  TypedNuxtLinkProps,
-  {},
-  {},
-  import('vue').ComputedOptions,
-  import('vue').MethodOptions,
-  import('vue').ComponentOptionsMixin,
-  import('vue').ComponentOptionsMixin,
-  {},
-  string,
-  import('vue').VNodeProps &
-    import('vue').AllowedComponentProps &
-    import('vue').ComponentCustomProps,
-  Readonly<TypedNuxtLinkProps>,
-  {}
->;
-
-declare module '@vue/runtime-core' {
-  export interface GlobalComponents {
-    NuxtLink: _NuxtLink;
-  }
-}
-`;
-
 const watermarkTemplate = `
   // @ts-nocheck
   // eslint-disable
@@ -164,13 +41,138 @@ const watermarkTemplate = `
  
 `;
 
-function createDeclarationRoutesFile() {
+function createRuntimeTypeUtils(autoImport) {
+  return `
+ // Type utils
+ type ExtractRequiredParameters<T extends Record<string, any>> = Pick<
+   T,
+   { [K in keyof T]: undefined extends T[K] ? never : K }[keyof T]
+ >;
+ 
+ type HasOneRequiredParameter<T extends TypedRouteList> = [TypedRouteParams[T]] extends [never]
+   ? false
+   : [keyof ExtractRequiredParameters<TypedRouteParams[T]>] extends [undefined]
+   ? false
+   : true;
+ 
+ type TypedLocationAsRelativeRaw<T extends TypedRouteList> = {
+   name?: T;
+ } & ([TypedRouteParams[T]] extends [never]
+   ? {}
+   : HasOneRequiredParameter<T> extends false
+   ? { params?: TypedRouteParams[T] }
+   : { params: TypedRouteParams[T] });
+ 
+ type ResolvedTypedLocationAsRelativeRaw<T extends TypedRouteList> = {
+   name?: T;
+ } & ([TypedRouteParams[T]] extends [never] ? {} : { params: TypedRouteParams[T] });
+ 
+ type TypedRouteLocationRaw = RouteQueryAndHash & TypedRouteNamedMapper & RouteLocationOptions;
+ 
+ type _TypedRoute = Omit<RouteLocationNormalizedLoaded, 'name' | 'params'> &
+   ResolvedTypedRouteNamedMapper;
+ type _TypedNamedRoute<T extends TypedRouteList> = Omit<
+   RouteLocationNormalizedLoaded,
+   'name' | 'params'
+ > &
+   ResolvedTypedLocationAsRelativeRaw<T>;
+ 
+ /** Augmented Router interface */
+ interface _TypedRouter
+   extends Omit<Router, 'removeRoute' | 'hasRoute' | 'resolve' | 'push' | 'replace', 'currentRoute'> {
+   readonly currentRoute: _TypedRoute;
+   /**
+    * Remove an existing route by its name.
+    *
+    * @param name - Name of the route to remove
+    */
+   removeRoute(name: TypedRouteList): void;
+   /**
+    * Checks if a route with a given name exists
+    *
+    * @param name - Name of the route to check
+    */
+   hasRoute(name: TypedRouteList): boolean;
+   /**
+    * Returns the {@link RouteLocation | normalized version} of a
+    * {@link RouteLocationRaw | route location}. Also includes an \`href\` property
+    * that includes any existing \`base\`. By default the \`currentLocation\` used is
+    * \`route.currentRoute\` and should only be overriden in advanced use cases.
+    *
+    * @param to - Raw route location to resolve
+    * @param currentLocation - Optional current location to resolve against
+    */
+   resolve(
+     to: TypedRouteLocationRaw,
+     currentLocation?: RouteLocationNormalizedLoaded
+   ): RouteLocation & {
+     href: string;
+   };
+   /**
+    * Programmatically navigate to a new URL by pushing an entry in the history
+    * stack.
+    *
+    * @param to - Route location to navigate to
+    */
+   push(to: TypedRouteLocationRaw): Promise<NavigationFailure | void | undefined>;
+   /**
+    * Programmatically navigate to a new URL by replacing the current entry in
+    * the history stack.
+    *
+    * @param to - Route location to navigate to
+    */
+   replace(to: TypedRouteLocationRaw): Promise<NavigationFailure | void | undefined>;
+ }
+ 
+ export interface TypedRouter extends _TypedRouter {}
+ export type TypedRoute = _TypedRoute;
+ export type TypedNamedRoute<T extends TypedRouteList> = _TypedNamedRoute<T>;
+ 
+ declare global {
+   export interface TypedRouter extends _TypedRouter {}
+   export type TypedRoute = _TypedRoute;
+   export type TypedNamedRoute<T extends TypedRouteList> = _TypedNamedRoute<T>;
+ 
+   ${autoImport ? `const useRoute: typeof useTypedRoute;
+      const useRouter: typeof useTypedRouter;` : ""}
+ }
+ 
+ type TypedNuxtLinkProps = Omit<NuxtLinkProps, 'to'> & {
+   to: string | Omit<Exclude<RouteLocationRaw, string>, 'name'> & TypedRouteNamedMapper;
+ };
+ 
+ type _NuxtLink = DefineComponent<
+   TypedNuxtLinkProps,
+   {},
+   {},
+   import('vue').ComputedOptions,
+   import('vue').MethodOptions,
+   import('vue').ComponentOptionsMixin,
+   import('vue').ComponentOptionsMixin,
+   {},
+   string,
+   import('vue').VNodeProps &
+     import('vue').AllowedComponentProps &
+     import('vue').ComponentCustomProps,
+   Readonly<TypedNuxtLinkProps>,
+   {}
+ >;
+ 
+ declare module '@vue/runtime-core' {
+   export interface GlobalComponents {
+     NuxtLink: _NuxtLink;
+   }
+ }
+ `;
+}
+
+function createDeclarationRoutesFile(autoImport) {
   return `
     ${watermarkTemplate}
     
     ${staticTypesImports}
 
-    ${staticTypeUtils}
+    ${createRuntimeTypeUtils(autoImport)}
   `;
 }
 
@@ -179,8 +181,8 @@ function createRuntimeIndexFile() {
   ${watermarkTemplate}
   export { routesNames } from './__routes';
   export type { TypedRouteList } from './__routes';
-  export * from './__useTypedRouter';
-  export * from './__useTypedRoute';
+  export {useRouter} from './__useTypedRouter';
+  export {useRoute} from './__useTypedRoute';
   `;
 }
 
@@ -280,7 +282,7 @@ function createUseTypedRouteFile(routesDeclTemplate) {
   return `
   ${watermarkTemplate}
   import { useRoute } from '#app';
-  import { TypedRouteList } from './__routes';
+  import type { TypedRouteList } from './__routes';
 
   /** Acts the same as \`useRoute\`, but typed.
  *
@@ -310,14 +312,16 @@ export function useTypedRoute<T extends TypedRouteList = never>(
   return route as any;
 }
 
-  `;
+export const useRoute = useTypedRoute;
+
+`;
 }
 
 function createRuntimeUseTypedRouterFile(routesDeclTemplate) {
   return `
   ${watermarkTemplate}
   import { useRouter } from '#app';
-  import { TypedRouter } from './typed-router';
+  import type { TypedRouter } from './typed-router';
 
   /** Returns instances of $typedRouter and $routesList fully typed to use in your components or your Vuex/Pinia store
    * 
@@ -333,6 +337,7 @@ function createRuntimeUseTypedRouterFile(routesDeclTemplate) {
     return router;
   };
 
+  export const useRouter = useTypedRouter;
   `;
 }
 
@@ -417,6 +422,7 @@ function handlePluginFileSave({
 let previousGeneratedRoutes = "";
 async function saveGeneratedFiles({
   rootDir,
+  autoImport,
   outputData: { routesDeclTemplate, routesList, routesObjectTemplate, routesParams }
 }) {
   const filesMap = [
@@ -439,7 +445,7 @@ async function saveGeneratedFiles({
     },
     {
       fileName: `typed-router.d.ts`,
-      content: createDeclarationRoutesFile()
+      content: createDeclarationRoutesFile(autoImport)
     },
     {
       fileName: "index.ts",
@@ -451,7 +457,7 @@ async function saveGeneratedFiles({
   );
   if (previousGeneratedRoutes !== routesList.join(",")) {
     previousGeneratedRoutes = routesList.join(",");
-    console.log(logSymbols.success, `[typed-router] Routes definitions generated`);
+    console.log(logSymbols.success, `Router autocompletions generated \u{1F6A6}`);
   }
 }
 
@@ -611,8 +617,10 @@ function startGenerator({ output, routesConfig }) {
   output.routesDeclTemplate += "}";
 }
 
-function createTypedRouter({ rootDir, plugin, nuxt }) {
+function createTypedRouter({ plugin, nuxt }) {
   try {
+    const rootDir = nuxt.options.rootDir;
+    const autoImport = nuxt.options.imports.autoImport ?? true;
     extendPages(async (routes) => {
       if (routes.length) {
         const outputData = constructRouteMap(routes);
@@ -624,6 +632,7 @@ function createTypedRouter({ rootDir, plugin, nuxt }) {
           });
         }
         await saveGeneratedFiles({
+          autoImport,
           rootDir,
           outputData
         });
@@ -663,8 +672,9 @@ const module = defineNuxtModule({
     nuxt.options.typescript.tsConfig = {
       include: ["./typed-router/typed-router.d.ts"]
     };
-    nuxt.hook("pages:extend", () => createTypedRouter({ rootDir, nuxt, plugin }));
-    createTypedRouter({ rootDir, nuxt, plugin });
+    const typedRouterOptions = { nuxt, plugin };
+    nuxt.hook("pages:extend", () => createTypedRouter(typedRouterOptions));
+    createTypedRouter(typedRouterOptions);
   }
 });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-typed-router",
-  "version": "2.1.0-beta.0",
+  "version": "2.1.0-beta.2",
   "description": "Provide autocompletion for pages route names generated by Nuxt router",
   "type": "module",
   "main": "./dist/module.cjs",