nuxt-typed-router 3.1.0-beta.0 → 3.1.0

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.json

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

package/dist/module.mjs

@@ -365,7 +365,7 @@ function createTypedRouterFile() {
   /**
    * 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(
@@ -373,6 +373,11 @@ function createTypedRouterFile() {
       `& {path?: TypedPathParameter<P>}`
     )}
   ${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
@@ -387,6 +392,27 @@ function createTypedRouterFile() {
     : { params: RoutesParamsRecord[T] });
 
   
+   /** 
+   * Used for type assertion:
+   * 
+   * @usage
+   * 
+   * \`\`\`ts
+   *  const myRoute = '/foo' as TypedRouteLocation;
+   * \`\`\`
+   * */
+  export type TypedRouteLocation<T extends string = '/'> =
+  | (Omit<Exclude<RouteLocationRaw, string>, 'name' | 'params'> & RoutesNamedLocations)
+  | Omit<RouteLocationPathRaw, 'path'>
+  ${returnIfTrue(
+      pathCheck && !strictOptions.router.strictRouteLocation,
+      `& {path?: TypedPathParameter<T>}`
+    )}
+  ${returnIfTrue(!pathCheck && !strictOptions.router.strictToArgument, ` | string`)}
+  ${returnIfTrue(pathCheck && !strictOptions.router.strictToArgument, `| TypedPathParameter<T>`)}
+  ;
+
+  
   /** Augmented Router with typed methods
    * {@link Router}
    */
@@ -446,6 +472,8 @@ function createTypedRouterFile() {
     )}
   }
 
+  
+
 
 
   // - Resolved normalized routes for current Location (ex: useRoute and currentRoute)
@@ -544,6 +572,10 @@ function createTypedRouterDefinitionFile() {
     )}
         ${returnIfTrue(!pathCheck && !strictOptions.NuxtLink.strictToArgument, ` | string`)}
         ${returnIfTrue(
+      pathCheck && strictOptions.NuxtLink.strictToArgument,
+      ` | (E extends true ? string : void)`
+    )}
+        ${returnIfTrue(
       pathCheck && !strictOptions.NuxtLink.strictToArgument,
       ` | (E extends true ? string : TypedPathParameter<T>)`
     )},
@@ -588,7 +620,8 @@ function createTypedRouterDefinitionFile() {
 }
 
 function createIndexFile() {
-  const { i18n, pathCheck } = moduleOptionStore;
+  const { i18n, i18nOptions, pathCheck } = moduleOptionStore;
+  const hasPrefixStrategy = i18n && i18nOptions?.strategy !== "no_prefix";
   return (
     /* typescript */
     `
@@ -598,6 +631,7 @@ function createIndexFile() {
       TypedResolvedMatcherLocation,
       TypedRoute,
       TypedRouteFromName,
+      TypedRouteLocation,
       TypedRouteLocationFromName,
       TypedRouteLocationRaw,
       TypedRouteLocationRawFromName,
@@ -621,9 +655,15 @@ function createIndexFile() {
     
     ${returnIfTrue(
       pathCheck,
-      `export type { ValidatePath, RoutePathSchema, TypedPathParameter, RouteNameFromPath } from './__paths';`
+      `export type { ValidatePath, RoutePathSchema, TypedPathParameter, RouteNameFromPath, ${returnIfTrue(
+        hasPrefixStrategy,
+        `TypedLocalePathParameter`
+      )} } from './__paths';`
+    )}
+    ${returnIfTrue(
+      i18n,
+      `export {useLocalePath, useLocaleRoute, TypedToLocalePath, TypedLocaleRoute} from './__i18n-router';`
     )}
-    ${returnIfTrue(i18n, `export {useLocalePath, useLocaleRoute} from './__i18n-router';`)}
 
     
   `
@@ -737,6 +777,10 @@ function createNavigateToFile() {
       `import type {TypedPathParameter, RouteNameFromPath} from './__paths';`
     )}
 
+    type TypedNavigateToOptions<E extends boolean> = Omit<NavigateToOptions, 'external'> & {
+      external?: E
+    }
+
     /** 
    * Typed clone of \`navigateTo\`
    * 
@@ -749,15 +793,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(
       pathCheck && !router.strictToArgument,
-      `<T extends string>(
-        to: TypedPathParameter<T>,
-        options?: NavigateToOptions
+      `<T extends string, E extends boolean = false>(
+        to: (E extends true ? string : TypedPathParameter<T>),
+        options?: TypedNavigateToOptions<E>
       ) : Promise<void | NavigationFailure | TypedRouteFromName<RouteNameFromPath<T>>>`
     )}
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-typed-router",
-  "version": "3.1.0-beta.0",
+  "version": "3.1.0",
   "description": "Provide autocompletion for routes paths, names and params in Nuxt apps",
   "type": "module",
   "main": "./dist/module.cjs",