nuxt-typed-router 3.0.0-beta.8 → 3.0.0

package/README.md

@@ -29,7 +29,7 @@
 
 <br/>
 <p align="center">
-  <img src="https://github.com/victorgarciaesgi/nuxt-typed-router/blob/master/.github/images/nuxt-router.gif?raw=true"/>
+  <img src="https://github.com/victorgarciaesgi/nuxt-typed-router/blob/master/.github/images/nuxt-typed-router.gif?raw=true"/>
 </p>
 <br/>
 

package/dist/module.json

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

package/dist/module.mjs

@@ -162,19 +162,42 @@ function createRoutesParamsRecordResolvedExport(routesParams) {
   }`;
 }
 
+function isItemLast(array, index) {
+  return array ? index === array.length - 1 : false;
+}
+function returnIfTrue(condition, template, otherwise) {
+  if (condition) {
+    return template;
+  }
+  return otherwise ?? "";
+}
+
 const nanoid = customAlphabet("ABCDEFGHIJKLMNOPQRSTUVWXYZ", 10);
 function createRoutePathSchema(routePaths) {
   return `export type RoutePathSchema = 
     ${routePaths.filter((f) => !!f.path).map((route) => `"${route.path}"`).join("|")}
   `;
 }
-function createValidatePathTypes(pathElements) {
-  let pathConditions = pathElements.map(createTypeValidatePathCondition);
+function createLocaleRoutePathSchema(routePaths) {
+  return `export type LocaleRoutePathSchema = 
+    ${routePaths.filter((f) => !!f.path && !f.isLocale).map((route) => `"${route.path}"`).join("|")}
+  `;
+}
+function createValidatePathTypes(pathElements, withLocale = false) {
+  let pathConditions = pathElements.map(createTypeValidatePathCondition).filter((f) => {
+    if (withLocale) {
+      return !f.isLocale;
+    }
+    return true;
+  });
   const conditionsList = pathConditions.map((m) => m.condition);
   return `
     ${pathConditions.length ? conditionsList.join("\n\n") : ""}
 
-    export type ValidatePath<T extends string> = T extends string 
+    export type Validate${returnIfTrue(
+    withLocale,
+    "Locale"
+  )}Path<T extends string> = T extends string 
       ? T extends '/' 
         ? T 
          ${pathConditions.length ? `:${pathConditions.map((t) => `${t.typeName}<T> extends true ? T`).join(": ")}` : ""} 
@@ -184,7 +207,10 @@ function createValidatePathTypes(pathElements) {
       : never;
   
   
-    export type RouteNameFromPath<T extends string> = T extends string 
+    export type RouteNameFrom${returnIfTrue(
+    withLocale,
+    "Locale"
+  )}Path<T extends string> = T extends string 
       ? T extends '/' 
         ? "index"
          ${pathConditions.length ? `: ${pathConditions.map((t) => `${t.typeName}<T> extends true ? "${t.routeName}"`).join(": ")} : never` : ": never"} 
@@ -197,6 +223,7 @@ function createTypeValidatePathCondition(elements) {
   const params = /* @__PURE__ */ new Map();
   const routeName = elements.flat()[0].routeName;
   const hasOnlyNames = elements.flat().every((elem) => elem.type === "name");
+  const isLocale = elements.flat()[0].isLocale;
   const condition = `type ${typeName}<T> = T extends \`/${elements.map((elementArray, index) => {
     return elementArray.map((elem) => {
       const isLast = index === elements.flat().length - 1;
@@ -238,7 +265,8 @@ function createTypeValidatePathCondition(elements) {
   return {
     typeName,
     condition,
-    routeName
+    routeName,
+    isLocale
   };
 }
 
@@ -276,16 +304,6 @@ function createRoutesTypesFile({
   );
 }
 
-function isItemLast(array, index) {
-  return array ? index === array.length - 1 : false;
-}
-function returnIfTrue(condition, template, otherwise) {
-  if (condition) {
-    return template;
-  }
-  return otherwise ?? "";
-}
-
 function createTypedRouterFile() {
   const strictOptions = moduleOptionStore.getResolvedStrictOptions();
   const { i18n, experimentalPathCheck } = moduleOptionStore;
@@ -776,7 +794,7 @@ function createi18nRouterFile() {
   import type {RoutesNamesList} from './__routes';
   ${returnIfTrue(
       experimentalPathCheck,
-      `import type {TypedPathParameter, RouteNameFromPath} from './__paths';`
+      `import type {TypedLocalePathParameter, RouteNameFromLocalePath} from './__paths';`
     )}
 
   export type I18nLocales = ${i18nOptions?.locales?.length ? i18nOptions.locales.map((loc) => `"${loc}"`).join("|") : "string"};
@@ -791,9 +809,9 @@ function createi18nRouterFile() {
     ${returnIfTrue(
       experimentalPathCheck && !router.strictToArgument,
       `<T extends string>(
-      to: TypedPathParameter<T>,
+      to: TypedLocalePathParameter<T>,
       locale?: I18nLocales | undefined
-    ) : [T] extends [never] ? string : Required<TypedRouteLocationRawFromName<RouteNameFromPath<T>, T>>;`
+    ) : [T] extends [never] ? string : Required<TypedRouteLocationRawFromName<RouteNameFromLocalePath<T>, T>>;`
     )}
   }
 
@@ -805,7 +823,7 @@ function createi18nRouterFile() {
     <T extends RoutesNamesList, P extends string>(to: TypedRouteLocationRawFromName<T, P>, locale?: I18nLocales | undefined) : TypedRouteFromName<T>
     ${returnIfTrue(
       experimentalPathCheck && !router.strictToArgument,
-      ` <T extends string>(to: TypedPathParameter<T>, locale?: I18nLocales | undefined) : TypedRouteFromName<RouteNameFromPath<T>>;`
+      ` <T extends string>(to: TypedLocalePathParameter<T>, locale?: I18nLocales | undefined) : TypedRouteFromName<RouteNameFromLocalePath<T>>;`
     )}
   }
 
@@ -838,12 +856,6 @@ function extractParamsFromPathDecl(path) {
   } while (matches);
   return params;
 }
-function replaceParamsFromPathDecl(path) {
-  const replacedPath = path.replace(routeParamExtractRegxp, (_, mtch, key, catchAll, optional) => {
-    return catchAll ? `\${((string | ''))}` : `\${(string ${optional ? "| ''" : ""})}`;
-  });
-  return replacedPath;
-}
 
 function extractRouteParamsFromPath(path, isIndexFileForRouting, previousParams) {
   const params = extractParamsFromPathDecl(path);
@@ -868,17 +880,17 @@ function extractRouteParamsFromPath(path, isIndexFileForRouting, previousParams)
 }
 
 const ExtractRegex = /(^(\/)?([^:/]+)?(:(\w+)(\(.+\)[*+]?)?(\?)?)*([^:/]+)?)+/g;
-function destructurePath(path, fullPath, routeName) {
+function destructurePath(path, route) {
   let allPathElements = [];
   let _path = `${path}`;
   do {
-    const { pathElements, strippedPath } = extractPathElements(_path, fullPath, routeName);
+    const { pathElements, strippedPath } = extractPathElements(_path, route);
     allPathElements = allPathElements.concat(pathElements);
     _path = _path.replace(strippedPath, "");
   } while (_path.length);
   return allPathElements;
 }
-function extractPathElements(partOfPath, fullPath, routeName) {
+function extractPathElements(partOfPath, route) {
   let pathElements = [];
   let strippedPath = "";
   let matches;
@@ -887,20 +899,34 @@ function extractPathElements(partOfPath, fullPath, routeName) {
     const [_, mtch, slash, path1, paramDef, key, catchAll, optional, path2] = matches;
     if (mtch) {
       strippedPath = mtch;
+      const sharedProperties = {
+        fullPath: route.path,
+        routeName: route.name,
+        isLocale: route.isLocale
+      };
       if (path1) {
-        pathElements.push({ type: "name", content: path1, fullPath, id: nanoid$1(6), routeName });
+        pathElements.push({
+          type: "name",
+          content: path1,
+          id: nanoid$1(6),
+          ...sharedProperties
+        });
       }
       if (key) {
         pathElements.push({
           type: catchAll ? "catchAll" : optional ? "optionalParam" : "param",
           content: key,
-          fullPath,
           id: nanoid$1(6),
-          routeName
+          ...sharedProperties
         });
       }
       if (path2) {
-        pathElements.push({ type: "name", content: path2, fullPath, id: nanoid$1(6), routeName });
+        pathElements.push({
+          type: "name",
+          content: path2,
+          id: nanoid$1(6),
+          ...sharedProperties
+        });
       }
     }
   }
@@ -908,6 +934,8 @@ function extractPathElements(partOfPath, fullPath, routeName) {
 }
 
 function createPathsFiles({ routesPaths }) {
+  const { i18n, i18nOptions } = moduleOptionStore;
+  const hasPrefixStrategy = i18n && i18nOptions?.strategy !== "no_prefix";
   const filteredRoutesPaths = routesPaths.filter(
     (route, index) => routesPaths.findIndex((r) => route.name === r.name) === index && !routesPaths.find((r) => `${route.path}/` === r.path)
   ).sort((a, b) => {
@@ -950,15 +978,18 @@ function createPathsFiles({ routesPaths }) {
     return order;
   });
   const pathElements = filteredRoutesPaths.filter((f) => f.path && f.path !== "/").map((route) => {
-    return route.path.split("/").filter((f) => f.length).map((m) => destructurePath(m, route.path, route.name));
+    return route.path.split("/").filter((f) => f.length).map((m) => destructurePath(m, route));
   });
   const validatePathTypes = createValidatePathTypes(pathElements);
+  const validateLocalePathTypes = createValidatePathTypes(pathElements, true);
   return (
     /* typescript */
     `
     
   ${createRoutePathSchema(filteredRoutesPaths)};
 
+  ${returnIfTrue(hasPrefixStrategy, createLocaleRoutePathSchema(filteredRoutesPaths))}
+
   type ValidStringPath<T> = T extends \`\${string} \${string}\` ? false : T extends '' ? false : true;
 
   type ValidParam<T, R extends boolean = true> = T extends \`\${infer A}/\${infer B}\`
@@ -1002,9 +1033,14 @@ function createPathsFiles({ routesPaths }) {
     : false;
 
   ${validatePathTypes}
+  ${returnIfTrue(hasPrefixStrategy, validateLocalePathTypes)}
 
 
-  export type TypedPathParameter<T extends string> = ValidatePath<T> | RoutePathSchema
+  export type TypedPathParameter<T extends string> = ValidatePath<T> | RoutePathSchema;
+  ${returnIfTrue(
+      hasPrefixStrategy,
+      `export type TypedLocalePathParameter<T extends string> = ValidateLocalePath<T> | LocaleRoutePathSchema;`
+    )}
 
   `
   );
@@ -1389,7 +1425,7 @@ function hasi18nSibling(source, route) {
 }
 function modifyRoutePrefixDefaultIfI18n(route) {
   const { i18n, i18nOptions } = moduleOptionStore;
-  if (i18n && route.name) {
+  if (i18n && route.name && i18nOptions?.strategy === "prefix_and_default") {
     const separator = i18nOptions?.routesNameSeparator ?? "___";
     const routeDefaultRegXp = new RegExp(
       `([a-zA-Z-]+)${separator}[a-zA-Z]+${separator}default`,
@@ -1409,52 +1445,57 @@ function walkThoughRoutes({
   parent,
   previousParams,
   output,
-  isLast
+  isLast,
+  isLocale
 }) {
   modifyRoutePrefixDefaultIfI18n(route);
-  if (!hasi18nSibling(output.routesPaths, route)) {
-    const newPath = `${parent?.path ?? ""}${route.path.startsWith("/") ? route.path : `/${route.path}`}`;
-    output.routesPaths.push({
-      name: route.name,
-      typePath: replaceParamsFromPathDecl(newPath),
-      path: newPath
-    });
-    if (route.children?.length) {
-      let childrenChunks = route.children;
-      let nameKey = createKeyedName(route, parent);
-      const allRouteParams = extractRouteParamsFromPath(route.path, false, previousParams);
-      const newRoute = { ...route, name: nameKey, path: newPath };
+  const newPath = `${parent?.path ?? ""}${route.path.startsWith("/") ? route.path : `/${route.path}`}`;
+  const isLocaleRoute = isLocale || hasi18nSibling(output.routesPaths, route);
+  output.routesPaths.push({
+    name: route.name,
+    path: newPath,
+    isLocale: isLocaleRoute
+  });
+  if (route.children?.length) {
+    let childrenChunks = route.children;
+    let nameKey = createKeyedName(route, parent);
+    const allRouteParams = extractRouteParamsFromPath(route.path, false, previousParams);
+    const newRoute = { ...route, name: nameKey, path: newPath };
+    if (!isLocaleRoute) {
       output.routesObjectTemplate += `${nameKey}:{`;
       output.routesDeclTemplate += `"${nameKey}":{`;
-      childrenChunks?.map(
-        (routeConfig, index) => walkThoughRoutes({
-          route: routeConfig,
-          level: level + 1,
-          siblings: extractUnMatchingSiblings(route, siblings),
-          parent: newRoute,
-          previousParams: allRouteParams,
-          output,
-          isLast: isItemLast(childrenChunks, index)
-        })
-      );
+    }
+    childrenChunks?.map(
+      (routeConfig, index) => walkThoughRoutes({
+        route: routeConfig,
+        level: level + 1,
+        siblings: extractUnMatchingSiblings(route, siblings),
+        parent: newRoute,
+        previousParams: allRouteParams,
+        output,
+        isLast: isItemLast(childrenChunks, index),
+        isLocale: isLocaleRoute
+      })
+    );
+    if (!isLocaleRoute) {
       output.routesObjectTemplate += "},";
       output.routesDeclTemplate += `}${isLast ? "" : ","}`;
-    } else if (route.name) {
-      let keyName = createNameKeyFromFullName(route, level, parent?.name);
-      output.routesObjectTemplate += `'${keyName}': '${route.name}' as const,`;
-      output.routesDeclTemplate += `"${keyName}": "${route.name}"${isLast ? "" : ","}`;
-      output.routesList.push(route.name);
-      const isIndexFileForRouting = route.path === "";
-      const allRouteParams = extractRouteParamsFromPath(
-        route.path,
-        isIndexFileForRouting,
-        previousParams
-      );
-      output.routesParams.push({
-        name: route.name,
-        params: allRouteParams
-      });
     }
+  } else if (route.name && !isLocaleRoute) {
+    let keyName = createNameKeyFromFullName(route, level, parent?.name);
+    output.routesObjectTemplate += `'${keyName}': '${route.name}' as const,`;
+    output.routesDeclTemplate += `"${keyName}": "${route.name}"${isLast ? "" : ","}`;
+    output.routesList.push(route.name);
+    const isIndexFileForRouting = route.path === "";
+    const allRouteParams = extractRouteParamsFromPath(
+      route.path,
+      isIndexFileForRouting,
+      previousParams
+    );
+    output.routesParams.push({
+      name: route.name,
+      params: allRouteParams
+    });
   }
 }
 
@@ -1465,14 +1506,12 @@ function constructRouteMap(routesConfig) {
     let routesList = [];
     let routesParams = [];
     let routesPaths = [];
-    let routesPathsTree = "{";
     const output = {
       routesObjectTemplate,
       routesDeclTemplate,
       routesList,
       routesParams,
-      routesPaths,
-      routesPathsTree
+      routesPaths
     };
     startGenerator({
       output,
@@ -1491,7 +1530,8 @@ function startGenerator({ output, routesConfig }) {
       level: 0,
       output,
       siblings: rootSiblingsRoutes,
-      isLast: isItemLast(routesConfig, index)
+      isLast: isItemLast(routesConfig, index),
+      isLocale: false
     });
   });
   output.routesObjectTemplate += "}";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "nuxt-typed-router",
-  "version": "3.0.0-beta.8",
-  "description": "Provide autocompletion for paths, routes names and params in Nuxt apps",
+  "version": "3.0.0",
+  "description": "Provide autocompletion for routes paths, names and params in Nuxt apps",
   "type": "module",
   "main": "./dist/module.cjs",
   "types": "./dist/types.d.ts",
@@ -70,7 +70,7 @@
     "prettier": "2.8.4"
   },
   "devDependencies": {
-    "@nuxt/devtools": "^0.1.4",
+    "@nuxt/devtools": "^0.1.6",
     "@nuxt/module-builder": "^0.2.1",
     "@nuxt/test-utils": "^3.2.2",
     "@nuxt/types": "^2.16.0",
@@ -81,21 +81,21 @@
     "@types/mkdirp": "^2.0.0",
     "@types/node": "^18.14.0",
     "@types/prettier": "^2.7.2",
-    "@typescript-eslint/eslint-plugin": "^5.52.0",
-    "@typescript-eslint/parser": "^5.52.0",
+    "@typescript-eslint/eslint-plugin": "^5.53.0",
+    "@typescript-eslint/parser": "^5.53.0",
     "@vue/test-utils": "^2.3.0",
     "cross-env": "^7.0.3",
     "eslint": "8.34.0",
     "eslint-config-prettier": "^8.6.0",
     "eslint-plugin-vue": "^9.9.0",
     "nuxt": "3.2.2",
-    "playwright": "1.30.0",
+    "playwright": "1.31.0",
     "standard-version": "^9.5.0",
     "tsd": "^0.25.0",
     "typescript": "^4.9.5",
     "vitest": "^0.28.5",
     "vue-eslint-parser": "^9.1.0",
     "vue-router": "^4.1.6",
-    "vue-tsc": "^1.1.4"
+    "vue-tsc": "^1.1.7"
   }
 }