nuxt-typed-router 2.1.1 → 2.1.2-beta.0

package/dist/module.json

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

package/dist/module.mjs

@@ -8,28 +8,6 @@ import { dirname, resolve } from 'pathe';
 import mkdirp from 'mkdirp';
 import { camelCase } from 'lodash-es';
 
-const staticTypesImports = `
-import type {
-  NavigationFailure,
-  RouteLocation,
-  RouteLocationNormalizedLoaded,
-  RouteLocationOptions,
-  RouteQueryAndHash,
-  RouteLocationRaw,
-  Router,
-} from 'vue-router';
-import type { DefineComponent } from 'vue';
-import type { NuxtLinkProps } from '#app';
-import type {
-  TypedRouteList,
-  TypedRouteNamedMapper,
-  TypedRouteParams,
-  ResolvedTypedRouteNamedMapper,
-} from './__routes';
-import {useRoute as _useRoute} from './__useTypedRoute';
-import {useRouter as _useRouter} from './__useTypedRouter';
-`;
-
 const watermarkTemplate = `
   // @ts-nocheck
   // eslint-disable
@@ -41,138 +19,49 @@ const watermarkTemplate = `
  
 `;
 
-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 _useRoute;
-      const useRouter: typeof _useRouter;` : ""}
- }
- 
- 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}
-
-    ${createRuntimeTypeUtils(autoImport)}
+    import type { NuxtLinkProps } from '#app';
+    import type { DefineComponent } from 'vue';
+    import type { RouteLocationRaw } from 'vue-router';
+    import type { TypedRouteNamedMapper } from './__routes';
+    import { useRoute as _useRoute } from './__useTypedRoute';
+    import { useRouter as _useRouter } from './__useTypedRouter';
+
+    declare global {
+ 
+      ${autoImport ? `const useRoute: typeof _useRoute;
+         const useRouter: typeof _useRouter;` : ""}
+    }
+    
+    type TypedNuxtLinkProps = Omit<NuxtLinkProps, 'to'> & {
+      to: string | Omit<Exclude<RouteLocationRaw, string>, 'name'> & TypedRouteNamedMapper;
+    };
+    
+    export 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;
+      }
+    }
   `;
 }
 
@@ -180,9 +69,10 @@ function createRuntimeIndexFile() {
   return `
   ${watermarkTemplate}
   export { routesNames } from './__routes';
-  export type { TypedRouteList } from './__routes';
+  export type { TypedRouteList, TypedRouteNamedMapper, TypedRouteParams } from './__routes';
   export {useRouter} from './__useTypedRouter';
   export {useRoute} from './__useTypedRoute';
+  export type {TypedRoute, TypedRouter, TypedNamedRoute } from './__router'
   `;
 }
 
@@ -190,6 +80,7 @@ function createRuntimePluginFile(routesDeclTemplate) {
   return `
   ${watermarkTemplate}
   import { defineNuxtPlugin } from '#app';
+  import {TypedRouter, TypedRoute} from '@typed-router';
 
   export default defineNuxtPlugin(() => {
     const router = useRouter();
@@ -271,7 +162,6 @@ function createRuntimeRoutesFile({
      * 
      * 
      * */
-
     ${createTypedRouteParamsExport(routesParams)}
 
     ${createTypedRouteNamedMapperExport(routesParams)}
@@ -285,6 +175,7 @@ function createUseTypedRouteFile(routesDeclTemplate) {
   ${watermarkTemplate}
   import { useRoute as defaultRoute } from '#app';
   import type { TypedRouteList } from './__routes';
+  import type {TypedRoute, TypedNamedRoute} from './__router'
 
   /** Acts the same as \`useRoute\`, but typed.
  *
@@ -322,7 +213,7 @@ function createRuntimeUseTypedRouterFile(routesDeclTemplate) {
   return `
   ${watermarkTemplate}
   import { useRouter as defaultRouter } from '#app';
-  import type { TypedRouter } from './typed-router';
+  import type { TypedRouter } from './__router';
 
   /** Returns instances of $typedRouter and $routesList fully typed to use in your components or your Vuex/Pinia store
    * 
@@ -341,6 +232,111 @@ function createRuntimeUseTypedRouterFile(routesDeclTemplate) {
   `;
 }
 
+function createRuntimeRouterTypes() {
+  return `
+  import type {
+    NavigationFailure,
+    RouteLocation,
+    RouteLocationNormalizedLoaded,
+    RouteLocationOptions,
+    RouteLocationRaw,
+    RouteQueryAndHash,
+    Router,
+  } from 'vue-router';
+  import type {
+    ResolvedTypedRouteNamedMapper,
+    TypedRouteList,
+    TypedRouteNamedMapper,
+    TypedRouteParams,
+  } from './__routes';
+
+  // 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>;
+  `;
+}
+
 const { resolveConfig, format } = prettier;
 const defaultPrettierOptions = {
   printWidth: 100,
@@ -443,6 +439,10 @@ async function saveGeneratedFiles({
         routesParams
       })
     },
+    {
+      fileName: `__router.d.ts`,
+      content: createRuntimeRouterTypes()
+    },
     {
       fileName: `typed-router.d.ts`,
       content: createDeclarationRoutesFile(autoImport)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-typed-router",
-  "version": "2.1.1",
+  "version": "2.1.2-beta.0",
   "description": "Provide autocompletion for pages route names generated by Nuxt router",
   "type": "module",
   "main": "./dist/module.cjs",
@@ -19,10 +19,12 @@
     "prepack": "nuxt-module-build",
     "dev": "nuxi dev playground",
     "dev:build": "nuxi build playground",
-    "dev:prepare": "nuxt-module-build --stub && nuxi prepare 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:fixtures": "nuxt-module-build --stub && nuxi prepare test/fixtures/simple && vitest run --dir test",
-    "test:types": "nuxi prepare test/fixtures/simple && cd test/fixtures/simple && vue-tsc --noEmit",
+    "test:prepare-fixtures": "nuxi prepare test/fixtures/simple",
+    "test:fixtures": " vitest run --dir test",
+    "test:types": "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"