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

package/dist/module.json

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

package/dist/module.mjs

@@ -392,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}
    */
@@ -451,6 +472,8 @@ function createTypedRouterFile() {
     )}
   }
 
+  
+
 
 
   // - Resolved normalized routes for current Location (ex: useRoute and currentRoute)
@@ -597,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 */
     `
@@ -607,6 +631,7 @@ function createIndexFile() {
       TypedResolvedMatcherLocation,
       TypedRoute,
       TypedRouteFromName,
+      TypedRouteLocation,
       TypedRouteLocationFromName,
       TypedRouteLocationRaw,
       TypedRouteLocationRawFromName,
@@ -630,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';`)}
 
     
   `

package/package.json

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