nuxt-typed-router 2.0.2 → 2.1.0-beta.0

package/dist/module.json

@@ -5,5 +5,5 @@
     "nuxt": "^3.0.0-rc.1",
     "bridge": false
   },
-  "version": "2.0.2"
+  "version": "2.1.0-beta.0"
 }

package/dist/module.mjs

@@ -26,6 +26,8 @@ import type {
   TypedRouteParams,
   ResolvedTypedRouteNamedMapper,
 } from './__routes';
+import {useTypedRoute} from './__useTypedRoute';
+import {useTypedRouter} from './__useTypedRouter';
 `;
 
 const staticTypeUtils = `
@@ -51,7 +53,7 @@ type TypedLocationAsRelativeRaw<T extends TypedRouteList> = {
 
 type ResolvedTypedLocationAsRelativeRaw<T extends TypedRouteList> = {
   name?: T;
-} & ([TypedRouteParams[T]] extends [never] ? {} : { params: Required<TypedRouteParams[T]> });
+} & ([TypedRouteParams[T]] extends [never] ? {} : { params: TypedRouteParams[T] });
 
 type TypedRouteLocationRaw = RouteQueryAndHash & TypedRouteNamedMapper & RouteLocationOptions;
 
@@ -65,7 +67,8 @@ type _TypedNamedRoute<T extends TypedRouteList> = Omit<
 
 /** Augmented Router interface */
 interface _TypedRouter
-  extends Omit<Router, 'removeRoute' | 'hasRoute' | 'resolve' | 'push' | 'replace'> {
+  extends Omit<Router, 'removeRoute' | 'hasRoute' | 'resolve' | 'push' | 'replace', 'currentRoute'> {
+  readonly currentRoute: _TypedRoute;
   /**
    * Remove an existing route by its name.
    *
@@ -117,6 +120,9 @@ declare global {
   export interface TypedRouter extends _TypedRouter {}
   export type TypedRoute = _TypedRoute;
   export type TypedNamedRoute<T extends TypedRouteList> = _TypedNamedRoute<T>;
+
+  const useRoute: typeof useTypedRoute;
+  const useRouter: typeof useTypedRouter;
 }
 
 type TypedNuxtLinkProps = Omit<NuxtLinkProps, 'to'> & {
@@ -215,7 +221,9 @@ function createTypedRouteNamedMapperExport(routesParams) {
   return `export type TypedRouteNamedMapper = 
     ${routesParams.map(
     ({ name, params }) => `{name: "${name}" ${params.length ? `, params${params.some((s) => s.required) ? "" : "?"}: {
-          ${params.map(({ key, required }) => `"${key}"${required ? "" : "?"}: string | number`).join(",\n")}
+          ${params.map(
+      ({ key, required, catchAll }) => `"${key}"${required ? "" : "?"}: (string | number)${catchAll ? "[]" : ""}`
+    ).join(",\n")}
         }` : ""}}`
   ).join("|\n")}
   `;
@@ -229,7 +237,7 @@ function createResolvedTypedRouteNamedMapperExport(routesParams) {
     ${routesParams.map(
     ({ name, params }) => `{name: "${name}" ${params.length ? `, params: {
                 ${params.map(
-      ({ key, notRequiredOnPage }) => `"${key}"${notRequiredOnPage ? "?" : ""}: string`
+      ({ key, notRequiredOnPage, catchAll }) => `"${key}"${notRequiredOnPage ? "?" : ""}: string${catchAll ? "[]" : ""}`
     ).join(",\n")}
         }` : ""}}`
   ).join("|\n")}
@@ -359,12 +367,12 @@ dirname(fileURLToPath(import.meta.url));
 async function processPathAndWriteFile({
   content,
   fileName,
-  srcDir,
+  rootDir,
   outDir
 }) {
   try {
     const finalOutDir = outDir ?? `.nuxt/typed-router`;
-    const processedOutDir = resolve(srcDir, finalOutDir);
+    const processedOutDir = resolve(rootDir, finalOutDir);
     const outputFile = resolve(process.cwd(), `${processedOutDir}/${fileName}`);
     const formatedContent = await formatOutputWithPrettier(content);
     if (fs.existsSync(outputFile)) {
@@ -391,15 +399,15 @@ async function writeFile(path, content) {
 
 function handlePluginFileSave({
   nuxt,
-  srcDir,
+  rootDir,
   routesDeclTemplate
 }) {
   const pluginName = "__typed-router.ts";
   nuxt.hook("build:done", async () => {
-    const pluginFolder = `${srcDir}/plugins`;
+    const pluginFolder = `${rootDir}/plugins`;
     await processPathAndWriteFile({
       outDir: pluginFolder,
-      srcDir,
+      rootDir,
       fileName: pluginName,
       content: createRuntimePluginFile(routesDeclTemplate)
     });
@@ -408,7 +416,7 @@ function handlePluginFileSave({
 
 let previousGeneratedRoutes = "";
 async function saveGeneratedFiles({
-  srcDir,
+  rootDir,
   outputData: { routesDeclTemplate, routesList, routesObjectTemplate, routesParams }
 }) {
   const filesMap = [
@@ -439,7 +447,7 @@ async function saveGeneratedFiles({
     }
   ];
   await Promise.all(
-    filesMap.map(({ content, fileName }) => processPathAndWriteFile({ srcDir, content, fileName }))
+    filesMap.map(({ content, fileName }) => processPathAndWriteFile({ rootDir, content, fileName }))
   );
   if (previousGeneratedRoutes !== routesList.join(",")) {
     previousGeneratedRoutes = routesList.join(",");
@@ -451,24 +459,25 @@ function isItemLast(array, index) {
   return array ? index === array.length - 1 : false;
 }
 
-const routeParamExtractRegxp = /(:(\w+)(\?)?)+/g;
+const routeParamExtractRegxp = /(:(\w+)(\(.+\)[*+]?)?(\?)?)+/g;
 function extractRouteParamsFromPath(path, isIndexFileForRouting, previousParams) {
   let params = [];
   let matches;
   do {
     matches = routeParamExtractRegxp.exec(path);
     if (matches) {
-      const [_, mtch, key, optional] = matches;
+      const [_, mtch, key, catchAll, optional] = matches;
       if (mtch) {
-        params.push({ name: key, optional: !!optional });
+        params.push({ name: key, optional: !!optional, catchAll: !!catchAll });
       }
     }
   } while (matches);
   let allMergedParams = params.map(
-    ({ name, optional }) => ({
+    ({ name, optional, catchAll }) => ({
       key: name,
       required: !optional,
-      notRequiredOnPage: optional
+      notRequiredOnPage: optional,
+      catchAll
     })
   );
   if (previousParams?.length) {
@@ -602,16 +611,20 @@ function startGenerator({ output, routesConfig }) {
   output.routesDeclTemplate += "}";
 }
 
-function createTypedRouter({ srcDir, plugin, nuxt }) {
+function createTypedRouter({ rootDir, plugin, nuxt }) {
   try {
     extendPages(async (routes) => {
       if (routes.length) {
         const outputData = constructRouteMap(routes);
         if (plugin) {
-          handlePluginFileSave({ nuxt, routesDeclTemplate: outputData.routesDeclTemplate, srcDir });
+          handlePluginFileSave({
+            nuxt,
+            routesDeclTemplate: outputData.routesDeclTemplate,
+            rootDir
+          });
         }
         await saveGeneratedFiles({
-          srcDir,
+          rootDir,
           outputData
         });
       } else {
@@ -640,15 +653,18 @@ const module = defineNuxtModule({
     plugin: false
   },
   setup(moduleOptions, nuxt) {
-    const srcDir = nuxt.options.srcDir;
+    const rootDir = nuxt.options.rootDir;
     const { plugin } = moduleOptions;
     const { resolve } = createResolver(import.meta.url);
     nuxt.options.alias = {
       ...nuxt.options.alias,
-      "@typed-router": resolve(`${nuxt.options.rootDir}/.nuxt/typed-router`)
+      "@typed-router": resolve(`${rootDir}/.nuxt/typed-router`)
+    };
+    nuxt.options.typescript.tsConfig = {
+      include: ["./typed-router/typed-router.d.ts"]
     };
-    nuxt.hook("pages:extend", () => createTypedRouter({ srcDir, nuxt, plugin }));
-    createTypedRouter({ srcDir, nuxt, plugin });
+    nuxt.hook("pages:extend", () => createTypedRouter({ rootDir, nuxt, plugin }));
+    createTypedRouter({ rootDir, nuxt, plugin });
   }
 });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-typed-router",
-  "version": "2.0.2",
+  "version": "2.1.0-beta.0",
   "description": "Provide autocompletion for pages route names generated by Nuxt router",
   "type": "module",
   "main": "./dist/module.cjs",
@@ -59,10 +59,11 @@
     "log-symbols": "^5.1.0",
     "mkdirp": "^1.0.4",
     "pathe": "1.0.0",
-    "prettier": "2.8.1"
+    "prettier": "2.8.3"
   },
   "devDependencies": {
     "@nuxt/module-builder": "^0.2.1",
+    "@nuxt/test-utils": "^3.0.0",
     "@nuxt/types": "^2.15.8",
     "@nuxtjs/eslint-config-typescript": "^12.0.0",
     "@types/lodash-es": "^4.17.6",
@@ -70,11 +71,12 @@
     "@types/node": "^17.0.23",
     "@types/prettier": "^2.7.2",
     "cross-env": "^7.0.3",
-    "eslint": "8.31.0",
+    "eslint": "8.32.0",
     "eslint-config-prettier": "^8.6.0",
+    "eslint-plugin-vue": "^9.9.0",
     "nuxt": "3.0.0",
     "typescript": "^4.9.4",
-    "vitest": "^0.27.0",
+    "vitest": "^0.27.2",
     "vue-router": "^4.1.6"
   }
 }