nuxt-typed-router 3.1.3 → 3.1.4

package/README.md

@@ -16,6 +16,9 @@
 [![npm downloads][npm-total-downloads-src]][npm-downloads-href]
 <img src='https://img.shields.io/npm/l/nuxt-typed-router.svg'>
 
+> ⚠️ Nuxt 3.4 introduced a breaking change in its router output
+> Install `v3.1.4-beta.0` of nuxt-typed-router if you're using this Nuxt version
+
 ## Provide a type safe router to Nuxt with auto-generated typed definitions for route path, name and params
 
 - Supports all programmatic navigation utils (`NuxtLink`, `useRouter`, `navigateTo`, `useRoute`, `useLocalePath`, etc...)

package/dist/module.json

@@ -5,5 +5,5 @@
     "nuxt": "^3.0.0",
     "bridge": false
   },
-  "version": "3.1.3"
+  "version": "3.1.4"
 }

package/dist/module.mjs

@@ -8,7 +8,7 @@ import prettier from 'prettier';
 import fs, { existsSync } from 'fs';
 import { fileURLToPath } from 'url';
 import { dirname, resolve } from 'pathe';
-import mkdirp from 'mkdirp';
+import { mkdirp } from 'mkdirp';
 import { camelCase } from 'lodash-es';
 import { readFile } from 'fs/promises';
 
@@ -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, E extends boolean = false> =
+  export type TypedRouteLocationRawFromName<T extends RoutesNamesList, P extends string = string> =
   | (Omit<Exclude<RouteLocationRaw, string>, 'name' | 'params'> & TypedLocationAsRelativeRaw<T>)
   | Omit<RouteLocationPathRaw, 'path'>
   ${returnIfTrue(
@@ -401,15 +401,10 @@ function createTypedRouterFile() {
    *  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>`)}
+  export type TypedRouteLocation<T extends '/' = '/'> =
+  TypedRouteLocationRawFromName<any, T>
+  ${returnIfTrue(!pathCheck && !strictOptions.router.strictToArgument, ` & string`)}
+  ${returnIfTrue(pathCheck && !strictOptions.router.strictToArgument, `& TypedPathParameter<T>`)}
   ;
 
   
@@ -795,7 +790,7 @@ function createNavigateToFile() {
 
   interface NavigateToFunction {
     <T extends RoutesNamesList, P extends string, E extends boolean = false>(
-      to: TypedRouteLocationRawFromName<T, P, E>,
+      to: TypedRouteLocationRawFromName<T, P>,
       options?: TypedNavigateToOptions<E>
     ) : Promise<void | NavigationFailure | TypedRouteFromName<T>>
     ${returnIfTrue(
@@ -839,6 +834,7 @@ function createTypeUtilsRuntimeFile() {
 function createi18nRouterFile() {
   const { router } = moduleOptionStore.getResolvedStrictOptions();
   const { i18nOptions, pathCheck, i18nLocales } = moduleOptionStore;
+  const LocalePathType = i18nOptions?.strategy === "no_prefix" ? "TypedPathParameter" : "TypedLocalePathParameter";
   return (
     /* typescript */
     `
@@ -848,7 +844,7 @@ function createi18nRouterFile() {
   import type {RoutesNamesList} from './__routes';
   ${returnIfTrue(
       pathCheck,
-      `import type {TypedLocalePathParameter, RouteNameFromLocalePath} from './__paths';`
+      `import type {TypedLocalePathParameter, TypedPathParameter, RouteNameFromLocalePath} from './__paths';`
     )}
 
   export type I18nLocales = ${i18nLocales?.length ? i18nLocales.map((loc) => `"${loc}"`).join("|") : "string"};
@@ -863,7 +859,7 @@ function createi18nRouterFile() {
     ${returnIfTrue(
       pathCheck && !router.strictToArgument,
       `<T extends string>(
-      to: TypedLocalePathParameter<T>,
+      to: ${LocalePathType}<T>,
       locale?: I18nLocales | undefined
     ) : [T] extends [never] ? string : Required<TypedRouteLocationRawFromName<RouteNameFromLocalePath<T>, T>>;`
     )}
@@ -877,7 +873,7 @@ function createi18nRouterFile() {
     <T extends RoutesNamesList, P extends string>(to: TypedRouteLocationRawFromName<T, P>, locale?: I18nLocales | undefined) : TypedRouteFromName<T>
     ${returnIfTrue(
       pathCheck && !router.strictToArgument,
-      ` <T extends string>(to: TypedLocalePathParameter<T>, locale?: I18nLocales | undefined) : TypedRouteFromName<RouteNameFromLocalePath<T>>;`
+      ` <T extends string>(to: ${LocalePathType}<T>, locale?: I18nLocales | undefined) : TypedRouteFromName<RouteNameFromLocalePath<T>>;`
     )}
   }
 
@@ -890,7 +886,7 @@ function createi18nRouterFile() {
   );
 }
 
-const routeParamExtractRegxp = /(:(\w+)(\(.+\)[*+]?)?(\?)?)+/g;
+const routeParamExtractRegxp = /(:(\w+)(\(.*[^(]\)[*+]?)?(\?)?)+/g;
 function extractParamsFromPathDecl(path) {
   let params = [];
   let matches;
@@ -933,7 +929,7 @@ function extractRouteParamsFromPath(path, isIndexFileForRouting, previousParams)
   return allMergedParams;
 }
 
-const ExtractRegex = /(^(\/)?([^:/]+)?(:(\w+)(\(.+\)[*+]?)?(\?)?)*([^:/]+)?)+/g;
+const ExtractRegex = /(^(\/)?([^:/]+)?(:(\w+)(\((.*)\)[*+]?)?(\?)?)*([^:/]+)?)+/g;
 function destructurePath(path, route) {
   let allPathElements = [];
   let _path = `${path}`;
@@ -950,7 +946,7 @@ function extractPathElements(partOfPath, route) {
   let matches;
   matches = ExtractRegex.exec(partOfPath);
   if (matches) {
-    const [_, mtch, slash, path1, paramDef, key, catchAll, optional, path2] = matches;
+    const [_, mtch, slash, path1, paramDef, key, catchAll, parentheseContent, optional, path2] = matches;
     if (mtch) {
       strippedPath = mtch;
       const sharedProperties = {
@@ -968,7 +964,7 @@ function extractPathElements(partOfPath, route) {
       }
       if (key) {
         pathElements.push({
-          type: catchAll ? "catchAll" : optional ? "optionalParam" : "param",
+          type: catchAll && parentheseContent ? "catchAll" : optional ? "optionalParam" : "param",
           content: key,
           id: nanoid$1(6),
           ...sharedProperties
@@ -990,7 +986,10 @@ function extractPathElements(partOfPath, route) {
 function createPathsFiles({ routesPaths }) {
   const { i18n, i18nOptions } = moduleOptionStore;
   const hasPrefixStrategy = i18n && i18nOptions?.strategy !== "no_prefix";
-  const filteredRoutesPaths = routesPaths.filter((route) => !routesPaths.find((r) => `${route.path}/` === r.path)).sort((a, b) => {
+  const filteredRoutesPaths = routesPaths.filter((route) => !routesPaths.find((r) => `${route.path}/` === r.path)).map((route) => ({
+    ...route,
+    path: route.path.replace(/\(\)/g, "")
+  })).sort((a, b) => {
     const pathCountA = a.path.split("/");
     const pathCountB = b.path.split("/");
     pathCountA.splice(0, 1);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-typed-router",
-  "version": "3.1.3",
+  "version": "3.1.4",
   "description": "Provide autocompletion for routes paths, names and params in Nuxt apps",
   "type": "module",
   "main": "./dist/module.cjs",
@@ -59,20 +59,20 @@
     "url": "https://github.com/victorgarciaesgi/nuxt-typed-router/issues"
   },
   "dependencies": {
-    "@nuxt/kit": "^3.3.2",
+    "@nuxt/kit": "^3.4.1",
     "chalk": "^5.2.0",
     "defu": "^6.1.2",
     "lodash-es": "^4.17.21",
     "log-symbols": "^5.1.0",
-    "mkdirp": "^2.1.6",
+    "mkdirp": "^3.0.0",
     "nanoid": "^4.0.2",
     "pathe": "1.1.0",
     "prettier": "2.8.7"
   },
   "devDependencies": {
-    "@nuxt/devtools": "^0.3.1",
-    "@nuxt/module-builder": "^0.2.1",
-    "@nuxt/test-utils": "^3.3.2",
+    "@nuxt/devtools": "^0.4.0",
+    "@nuxt/module-builder": "^0.3.0",
+    "@nuxt/test-utils": "^3.4.1",
     "@nuxt/types": "^2.16.3",
     "@nuxtjs/eslint-config-typescript": "^12.0.0",
     "@nuxtjs/i18n": "8.0.0-beta.9",
@@ -80,21 +80,21 @@
     "@types/lodash-es": "^4.17.7",
     "@types/node": "^18.15.11",
     "@types/prettier": "^2.7.2",
-    "@typescript-eslint/eslint-plugin": "^5.57.0",
-    "@typescript-eslint/parser": "^5.57.0",
+    "@typescript-eslint/eslint-plugin": "^5.58.0",
+    "@typescript-eslint/parser": "^5.58.0",
     "@vue/test-utils": "^2.3.2",
     "bumpp": "9.1.0",
     "changelogithub": "0.12.7",
     "cross-env": "^7.0.3",
-    "eslint": "8.37.0",
+    "eslint": "8.38.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-vue": "^9.10.0",
-    "nuxt": "3.3.2",
-    "nuxt-seo-kit": "1.3.5",
-    "playwright": "1.32.1",
+    "nuxt": "3.4.1",
+    "nuxt-seo-kit": "1.3.6",
+    "playwright": "1.32.3",
     "tsd": "^0.28.1",
-    "typescript": "^5.0.3",
-    "vitest": "^0.29.8",
+    "typescript": "^5.0.4",
+    "vitest": "^0.30.1",
     "vue-eslint-parser": "^9.1.1",
     "vue-router": "^4.1.6",
     "vue-tsc": "^1.1.7"