nuxt-typed-router 3.0.9 → 3.1.0-beta.1

package/README.md

@@ -66,7 +66,7 @@ npm install -D nuxt-typed-router
 pnpm install -D nuxt-typed-router
 ```
 
-### Nuxt 2 legacy
+### Nuxt 2 legacy (not maintained)
 
 Nuxt 2 version is no longer maintained, but still available in [`nuxt2` branch](https://github.com/victorgarciaesgi/nuxt-typed-router/tree/nuxt2)
 It only has route name autocomplete functionnality
@@ -86,15 +86,6 @@ export default defineNuxtConfig({
 });
 ```
 
-
-# Roadmap
-
-- [x] Add `path` autocomplete with TS string templates
-- [x] Add support for `validate` and `redirect` in `definePageMeta`
-- [x] Add `strict` option to prevent path navigation
-- [ ] Enforce strong params typing depending of origin route
-
-
 ## Development
 
 1. Clone this repository

package/dist/module.d.ts

@@ -2,13 +2,12 @@ import * as _nuxt_schema from '@nuxt/schema';
 
 interface ModuleOptions {
     /**
-     * ⛔️ Experimental, disable it if you encounter problems
      *
      * Enables path autocomplete and path validity for programmatic validation
      *
      *  @default true
      */
-    experimentalPathCheck?: boolean;
+    pathCheck?: boolean;
     /**
      * Set to false if you don't want a plugin generated
      * @default false

package/dist/module.json

@@ -5,5 +5,5 @@
     "nuxt": "^3.0.0",
     "bridge": false
   },
-  "version": "3.0.9"
+  "version": "3.1.0-beta.1"
 }

package/dist/module.mjs

@@ -16,7 +16,7 @@ class ModuleOptionsStore {
   constructor() {
     this.plugin = false;
     this.strict = false;
-    this.experimentalPathCheck = true;
+    this.pathCheck = true;
     this.autoImport = false;
     this.rootDir = "";
     this.buildDir = "";
@@ -49,8 +49,8 @@ class ModuleOptionsStore {
         });
       }
     }
-    if (options.experimentalPathCheck != null) {
-      this.experimentalPathCheck = options.experimentalPathCheck;
+    if (options.pathCheck != null) {
+      this.pathCheck = options.pathCheck;
     }
   }
   getResolvedStrictOptions() {
@@ -317,7 +317,7 @@ function createRoutesTypesFile({
 
 function createTypedRouterFile() {
   const strictOptions = moduleOptionStore.getResolvedStrictOptions();
-  const { i18n, experimentalPathCheck } = moduleOptionStore;
+  const { i18n, pathCheck } = moduleOptionStore;
   return (
     /* typescript */
     `
@@ -339,7 +339,7 @@ function createTypedRouterFile() {
     RoutesParamsRecordResolved,
   } from './__routes';
   ${returnIfTrue(
-      experimentalPathCheck,
+      pathCheck,
       `import type {TypedPathParameter, RouteNameFromPath} from './__paths';`
     )}
   import type { HasOneRequiredParameter } from './__types_utils';
@@ -355,24 +355,29 @@ function createTypedRouterFile() {
   | (Omit<Exclude<RouteLocationRaw, string>, 'name' | 'params'> & RoutesNamedLocations)
   | Omit<RouteLocationPathRaw, 'path'>
   ${returnIfTrue(
-      experimentalPathCheck && !strictOptions.router.strictRouteLocation,
+      pathCheck && !strictOptions.router.strictRouteLocation,
       `& {path?: TypedPathParameter<T>}`
     )}
-  ${returnIfTrue(!experimentalPathCheck && !strictOptions.router.strictToArgument, ` | string`)}
+  ${returnIfTrue(!pathCheck && !strictOptions.router.strictToArgument, ` | string`)}
   ;
   
 
   /**
    * Alternative version of {@link TypedRouteLocationRaw} but with a name generic
    */
-  export type TypedRouteLocationRawFromName<T extends RoutesNamesList, P extends string = string> =
+  export type TypedRouteLocationRawFromName<T extends RoutesNamesList, P extends string = string, E extends boolean = false> =
   | (Omit<Exclude<RouteLocationRaw, string>, 'name' | 'params'> & TypedLocationAsRelativeRaw<T>)
   | Omit<RouteLocationPathRaw, 'path'>
   ${returnIfTrue(
-      experimentalPathCheck && !strictOptions.router.strictRouteLocation,
+      pathCheck && !strictOptions.router.strictRouteLocation,
       `& {path?: TypedPathParameter<P>}`
     )}
-  ${returnIfTrue(!experimentalPathCheck && !strictOptions.router.strictToArgument, ` | string`)}
+  ${returnIfTrue(!pathCheck && !strictOptions.router.strictToArgument, ` | string`)}
+  ${returnIfTrue(
+      pathCheck && strictOptions.router.strictToArgument,
+      `| (E extends true ? string : void)`
+    )}
+
 
   /** 
    * Generic providing inference and dynamic inclusion of \`params\` property
@@ -419,7 +424,7 @@ function createTypedRouterFile() {
       currentLocation?: TypedRouteLocationRaw
     ): TypedRouteLocationFromName<T>;
     ${returnIfTrue(
-      experimentalPathCheck && !strictOptions.router.strictToArgument,
+      pathCheck && !strictOptions.router.strictToArgument,
       `resolve<T extends string>(to: TypedPathParameter<T>, currentLocation?: TypedRouteLocationRaw): TypedRouteLocationFromName<RouteNameFromPath<T>>;`
     )}
     /**
@@ -430,7 +435,7 @@ function createTypedRouterFile() {
      */
     push<T extends RoutesNamesList, P extends string>(to: TypedRouteLocationRawFromName<T, P>): Promise<NavigationFailure | void | undefined>;
     ${returnIfTrue(
-      experimentalPathCheck && !strictOptions.router.strictToArgument,
+      pathCheck && !strictOptions.router.strictToArgument,
       `push<T extends string>(to: TypedPathParameter<T>): Promise<NavigationFailure | void | undefined>;`
     )}
     /**
@@ -441,7 +446,7 @@ function createTypedRouterFile() {
      */
     replace<T extends RoutesNamesList, P extends string>(to: TypedRouteLocationRawFromName<T, P>): Promise<NavigationFailure | void | undefined>;
     ${returnIfTrue(
-      experimentalPathCheck && !strictOptions.router.strictToArgument,
+      pathCheck && !strictOptions.router.strictToArgument,
       `replace<T extends string>(to: TypedPathParameter<T>): Promise<NavigationFailure | void | undefined>;`
     )}
   }
@@ -487,7 +492,7 @@ function createTypedRouterFile() {
 
 function createTypedRouterDefinitionFile() {
   const strictOptions = moduleOptionStore.getResolvedStrictOptions();
-  const { plugin, autoImport, i18n, experimentalPathCheck } = moduleOptionStore;
+  const { plugin, autoImport, i18n, pathCheck } = moduleOptionStore;
   return (
     /* typescript */
     `
@@ -507,7 +512,7 @@ function createTypedRouterDefinitionFile() {
 
     import {definePageMeta as _definePageMeta} from './__definePageMeta';
 
-    ${returnIfTrue(experimentalPathCheck, `import type {TypedPathParameter} from './__paths';`)}
+    ${returnIfTrue(pathCheck, `import type {TypedPathParameter} from './__paths';`)}
 
 
     declare global {
@@ -533,32 +538,34 @@ function createTypedRouterDefinitionFile() {
     )}
     }
     
-    type TypedNuxtLinkProps<T extends string> = Omit<NuxtLinkProps, 'to'> &
+    type TypedNuxtLinkProps<T extends string, E extends boolean = false> = Omit<NuxtLinkProps, 'to' | 'external'> &
      {
       to: 
         | Omit<Exclude<RouteLocationRaw, string>, 'name' | 'params'> & RoutesNamedLocations
         | Omit<RouteLocationPathRaw, 'path'>
         ${returnIfTrue(
-      experimentalPathCheck && !strictOptions.NuxtLink.strictRouteLocation,
-      `& {path?: TypedPathParameter<T>}`
+      pathCheck && !strictOptions.NuxtLink.strictRouteLocation,
+      `& {path?: (E extends true ? string : TypedPathParameter<T>)}`
     )}
+        ${returnIfTrue(!pathCheck && !strictOptions.NuxtLink.strictToArgument, ` | string`)}
         ${returnIfTrue(
-      !experimentalPathCheck && !strictOptions.NuxtLink.strictToArgument,
-      ` | string`
+      pathCheck && strictOptions.NuxtLink.strictToArgument,
+      ` | (E extends true ? string : void)`
     )}
         ${returnIfTrue(
-      experimentalPathCheck && !strictOptions.NuxtLink.strictToArgument,
-      ` | TypedPathParameter<T>`
-    )}
+      pathCheck && !strictOptions.NuxtLink.strictToArgument,
+      ` | (E extends true ? string : TypedPathParameter<T>)`
+    )},
+      external?: E
       }
     
         
           
-    export type TypedNuxtLink = new <P extends string>(props: TypedNuxtLinkProps<P>) => Omit<
+    export type TypedNuxtLink = new <P extends string, E extends boolean = false>(props: TypedNuxtLinkProps<P, E>) => Omit<
       typeof NuxtLink,
       '$props'
     > & {
-      $props: TypedNuxtLinkProps<P>;
+      $props: TypedNuxtLinkProps<P, E>;
     };
     
     // Declare runtime-core instead of vue for compatibility issues with pnpm
@@ -590,7 +597,7 @@ function createTypedRouterDefinitionFile() {
 }
 
 function createIndexFile() {
-  const { i18n, experimentalPathCheck } = moduleOptionStore;
+  const { i18n, pathCheck } = moduleOptionStore;
   return (
     /* typescript */
     `
@@ -622,7 +629,7 @@ function createIndexFile() {
     export { helpers } from './__helpers';
     
     ${returnIfTrue(
-      experimentalPathCheck,
+      pathCheck,
       `export type { ValidatePath, RoutePathSchema, TypedPathParameter, RouteNameFromPath } from './__paths';`
     )}
     ${returnIfTrue(i18n, `export {useLocalePath, useLocaleRoute} from './__i18n-router';`)}
@@ -725,7 +732,7 @@ function createUseTypedRouterFile() {
 
 function createNavigateToFile() {
   const { router } = moduleOptionStore.getResolvedStrictOptions();
-  const { experimentalPathCheck } = moduleOptionStore;
+  const { pathCheck } = moduleOptionStore;
   return (
     /* typescript */
     `
@@ -735,10 +742,14 @@ function createNavigateToFile() {
     import type { TypedRouteLocationRawFromName, TypedRouteFromName, TypedRoute } from './__router';
     import type { RoutesNamesList } from './__routes';
     ${returnIfTrue(
-      experimentalPathCheck,
+      pathCheck,
       `import type {TypedPathParameter, RouteNameFromPath} from './__paths';`
     )}
 
+    type TypedNavigateToOptions<E extends boolean> = Omit<NavigateToOptions, 'external'> & {
+      external?: E
+    }
+
     /** 
    * Typed clone of \`navigateTo\`
    * 
@@ -751,15 +762,15 @@ function createNavigateToFile() {
   
 
   interface NavigateToFunction {
-    <T extends RoutesNamesList, P extends string>(
-      to: TypedRouteLocationRawFromName<T, P>,
-      options?: NavigateToOptions
+    <T extends RoutesNamesList, P extends string, E extends boolean = false>(
+      to: TypedRouteLocationRawFromName<T, P, E>,
+      options?: TypedNavigateToOptions<E>
     ) : Promise<void | NavigationFailure | TypedRouteFromName<T>>
     ${returnIfTrue(
-      experimentalPathCheck && !router.strictToArgument,
-      `<T extends string>(
-        to: TypedPathParameter<T>,
-        options?: NavigateToOptions
+      pathCheck && !router.strictToArgument,
+      `<T extends string, E extends boolean = false>(
+        to: (E extends true ? string : TypedPathParameter<T>),
+        options?: TypedNavigateToOptions<E>
       ) : Promise<void | NavigationFailure | TypedRouteFromName<RouteNameFromPath<T>>>`
     )}
   }
@@ -795,7 +806,7 @@ function createTypeUtilsRuntimeFile() {
 
 function createi18nRouterFile() {
   const { router } = moduleOptionStore.getResolvedStrictOptions();
-  const { i18nOptions, experimentalPathCheck, i18nLocales } = moduleOptionStore;
+  const { i18nOptions, pathCheck, i18nLocales } = moduleOptionStore;
   return (
     /* typescript */
     `
@@ -804,7 +815,7 @@ function createi18nRouterFile() {
   import type {TypedRouteLocationRawFromName, TypedLocationAsRelativeRaw, TypedRouteFromName} from './__router';
   import type {RoutesNamesList} from './__routes';
   ${returnIfTrue(
-      experimentalPathCheck,
+      pathCheck,
       `import type {TypedLocalePathParameter, RouteNameFromLocalePath} from './__paths';`
     )}
 
@@ -818,7 +829,7 @@ function createi18nRouterFile() {
     (Omit<Exclude<RouteLocationRaw, string>, 'name' | 'params'> & TypedLocationAsRelativeRaw<T>)
     >
     ${returnIfTrue(
-      experimentalPathCheck && !router.strictToArgument,
+      pathCheck && !router.strictToArgument,
       `<T extends string>(
       to: TypedLocalePathParameter<T>,
       locale?: I18nLocales | undefined
@@ -833,7 +844,7 @@ function createi18nRouterFile() {
   export interface TypedLocaleRoute {
     <T extends RoutesNamesList, P extends string>(to: TypedRouteLocationRawFromName<T, P>, locale?: I18nLocales | undefined) : TypedRouteFromName<T>
     ${returnIfTrue(
-      experimentalPathCheck && !router.strictToArgument,
+      pathCheck && !router.strictToArgument,
       ` <T extends string>(to: TypedLocalePathParameter<T>, locale?: I18nLocales | undefined) : TypedRouteFromName<RouteNameFromLocalePath<T>>;`
     )}
   }
@@ -1057,7 +1068,7 @@ function createPathsFiles({ routesPaths }) {
 
 function createDefinePageMetaFile() {
   const strictOptions = moduleOptionStore.getResolvedStrictOptions();
-  const { experimentalPathCheck } = moduleOptionStore;
+  const { pathCheck } = moduleOptionStore;
   return (
     /* typescript */
     `
@@ -1066,7 +1077,7 @@ function createDefinePageMetaFile() {
   import type {PageMeta, NuxtError} from '#app'
   import type {TypedRouteFromName, TypedRoute, TypedRouteLocationRawFromName, TypedRouteLocationRaw} from './__router';
   import type {RoutesNamesList} from './__routes';
-  ${returnIfTrue(experimentalPathCheck, `import type {TypedPathParameter} from './__paths';`)}
+  ${returnIfTrue(pathCheck, `import type {TypedPathParameter} from './__paths';`)}
 
   type FilteredPageMeta = {
     [T in keyof PageMeta as [unknown] extends [PageMeta[T]] ? never : T]: PageMeta[T];
@@ -1118,7 +1129,7 @@ export function definePageMeta<P extends string, U extends RoutesNamesList>(
   meta: TypedPageMeta<never> & { redirect: TypedRouteLocationRawFromName<U, P> }
 ): void;
 ${returnIfTrue(
-      experimentalPathCheck && !strictOptions.router.strictToArgument,
+      pathCheck && !strictOptions.router.strictToArgument,
       `export function definePageMeta<P extends string>(
   meta: TypedPageMeta<never> & { redirect: TypedPathParameter<P> }
 ): void;`
@@ -1126,7 +1137,7 @@ ${returnIfTrue(
 export function definePageMeta<P extends string = string>(
   meta: TypedPageMeta<never> & {
     redirect?: (to: TypedRoute) => TypedRouteLocationRaw<P> ${returnIfTrue(
-      experimentalPathCheck && !strictOptions.router.strictToArgument,
+      pathCheck && !strictOptions.router.strictToArgument,
       ` | TypedPathParameter<P>`
     )};
   }
@@ -1134,7 +1145,7 @@ export function definePageMeta<P extends string = string>(
 export function definePageMeta<P extends string = string>(
   meta: TypedPageMeta<never> & {
     redirect?: () => TypedRouteLocationRaw<P> ${returnIfTrue(
-      experimentalPathCheck && !strictOptions.router.strictToArgument,
+      pathCheck && !strictOptions.router.strictToArgument,
       ` | TypedPathParameter<P>`
     )};
   }
@@ -1145,7 +1156,7 @@ export function definePageMeta<
   U extends RoutesNamesList
 >(routeName: T, meta: TypedPageMeta<T> & { redirect: TypedRouteLocationRawFromName<U, P> }): void;
 ${returnIfTrue(
-      experimentalPathCheck && !strictOptions.router.strictToArgument,
+      pathCheck && !strictOptions.router.strictToArgument,
       `export function definePageMeta<T extends RoutesNamesList, P extends string>(
   routeName: T,
   meta: TypedPageMeta<T> & { redirect: TypedPathParameter<P> }
@@ -1159,7 +1170,7 @@ export function definePageMeta<
   routeName: T,
   meta: TypedPageMeta<T> & {
     redirect?: (to: TypedRouteFromName<T>) => TypedRouteLocationRaw<P> ${returnIfTrue(
-      experimentalPathCheck && !strictOptions.router.strictToArgument,
+      pathCheck && !strictOptions.router.strictToArgument,
       ` | TypedPathParameter<P>`
     )};
   }
@@ -1168,7 +1179,7 @@ export function definePageMeta<T extends RoutesNamesList, P extends string>(
   routeName: T,
   meta: TypedPageMeta<T> & {
     redirect?: () => TypedRouteLocationRaw<P> ${returnIfTrue(
-      experimentalPathCheck && !strictOptions.router.strictToArgument,
+      pathCheck && !strictOptions.router.strictToArgument,
       ` | TypedPathParameter<P>`
     )};
   }
@@ -1187,7 +1198,7 @@ export function definePageMeta(metaOrName: any, meta?: any): void {
 }
 
 function createHelpersFile() {
-  const { experimentalPathCheck } = moduleOptionStore;
+  const { pathCheck } = moduleOptionStore;
   return (
     /* typescript */
     `
@@ -1198,7 +1209,7 @@ function createHelpersFile() {
   import type { TypedRouteLocationRawFromName, TypedLocationAsRelativeRaw } from './__router';
   import type { RoutesNamesList } from './__routes';
   ${returnIfTrue(
-      experimentalPathCheck,
+      pathCheck,
       `import type {TypedPathParameter, RouteNameFromPath} from './__paths';`
     )}
 
@@ -1381,7 +1392,7 @@ async function saveGeneratedFiles({ outputData }) {
       console.log(
         logSymbols.warning,
         chalk.yellow(
-          `Route path autocomplete is still experimental. You can disable it with the "nuxtTypedRouter.experimentalPathCheck: false" option`
+          `Route path autocomplete is still experimental. You can disable it with the "nuxtTypedRouter.pathCheck: false" option`
         )
       );
     }
@@ -1666,7 +1677,7 @@ const module = defineNuxtModule({
   defaults: {
     plugin: false,
     strict: false,
-    experimentalPathCheck: true,
+    pathCheck: true,
     experimentalRemoveNuxtDefs: true
   },
   setup(moduleOptions, nuxt) {
@@ -1700,7 +1711,7 @@ const module = defineNuxtModule({
     };
     nuxt.hook("prepare:types", (options) => {
       options.tsConfig.include?.unshift("./typed-router/typed-router.d.ts");
-      if (moduleOptions.experimentalPathCheck) {
+      if (moduleOptions.pathCheck) {
         options.tsConfig.vueCompilerOptions = {
           jsxTemplates: true,
           experimentalRfc436: true

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-typed-router",
-  "version": "3.0.9",
+  "version": "3.1.0-beta.1",
   "description": "Provide autocompletion for routes paths, names and params in Nuxt apps",
   "type": "module",
   "main": "./dist/module.cjs",
@@ -59,43 +59,43 @@
     "url": "https://github.com/victorgarciaesgi/nuxt-typed-router/issues"
   },
   "dependencies": {
-    "@nuxt/kit": "^3.3.1",
+    "@nuxt/kit": "^3.3.2",
     "chalk": "^5.2.0",
     "defu": "^6.1.2",
     "lodash-es": "^4.17.21",
     "log-symbols": "^5.1.0",
-    "mkdirp": "^2.1.5",
-    "nanoid": "^4.0.1",
+    "mkdirp": "^2.1.6",
+    "nanoid": "^4.0.2",
     "pathe": "1.1.0",
-    "prettier": "2.8.6"
+    "prettier": "2.8.7"
   },
   "devDependencies": {
-    "@nuxt/devtools": "^0.2.5",
+    "@nuxt/devtools": "^0.3.1",
     "@nuxt/module-builder": "^0.2.1",
-    "@nuxt/test-utils": "^3.3.1",
+    "@nuxt/test-utils": "^3.3.2",
     "@nuxt/types": "^2.16.3",
     "@nuxtjs/eslint-config-typescript": "^12.0.0",
     "@nuxtjs/i18n": "8.0.0-beta.9",
     "@nuxtjs/web-vitals": "^0.2.4",
     "@types/lodash-es": "^4.17.7",
-    "@types/node": "^18.15.5",
+    "@types/node": "^18.15.11",
     "@types/prettier": "^2.7.2",
-    "@typescript-eslint/eslint-plugin": "^5.56.0",
-    "@typescript-eslint/parser": "^5.56.0",
+    "@typescript-eslint/eslint-plugin": "^5.57.0",
+    "@typescript-eslint/parser": "^5.57.0",
     "@vue/test-utils": "^2.3.2",
-    "bumpp": "9.0.0",
+    "bumpp": "9.1.0",
     "changelogithub": "0.12.7",
     "cross-env": "^7.0.3",
-    "eslint": "8.36.0",
+    "eslint": "8.37.0",
     "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-vue": "^9.9.0",
-    "nuxt": "3.3.1",
+    "eslint-plugin-vue": "^9.10.0",
+    "nuxt": "3.3.2",
     "nuxt-seo-kit": "1.3.5",
-    "playwright": "1.31.2",
-    "tsd": "^0.28.0",
-    "typescript": "^5.0.2",
-    "vitest": "^0.29.7",
-    "vue-eslint-parser": "^9.1.0",
+    "playwright": "1.32.1",
+    "tsd": "^0.28.1",
+    "typescript": "^5.0.3",
+    "vitest": "^0.29.8",
+    "vue-eslint-parser": "^9.1.1",
     "vue-router": "^4.1.6",
     "vue-tsc": "^1.1.7"
   }