nuxt-typed-router 3.2.6 → 3.3.1

package/dist/module.d.ts

@@ -28,6 +28,13 @@ interface ModuleOptions {
      * @default true
      */
     experimentalRemoveNuxtDefs?: boolean;
+    /**
+     * ⚠️ Experimental
+     *
+     * Exclude certain routes from being included into the generated types
+     * Ex: 404 routes or catchAll routes
+     */
+    experimentalIgnoreRoutes?: string[];
 }
 interface StrictOptions {
     NuxtLink?: StrictParamsOptions;

package/dist/module.json

@@ -5,5 +5,5 @@
     "nuxt": "^3.0.0",
     "bridge": false
   },
-  "version": "3.2.6"
+  "version": "3.3.1"
 }

package/dist/module.mjs

@@ -1,6 +1,7 @@
 import { addPluginTemplate, extendPages, createResolver, defineNuxtModule } from '@nuxt/kit';
 import chalk from 'chalk';
 import logSymbols from 'log-symbols';
+import path from 'path';
 import { defu } from 'defu';
 import { customAlphabet } from 'nanoid/non-secure';
 import { nanoid as nanoid$1 } from 'nanoid';
@@ -19,9 +20,12 @@ class ModuleOptionsStore {
     this.autoImport = false;
     this.rootDir = "";
     this.buildDir = "";
+    this.srcDir = "";
+    this.pagesDir = "";
     this.i18n = false;
     this.i18nOptions = null;
     this.i18nLocales = [];
+    this.experimentalIgnoreRoutes = [];
   }
   updateOptions(options) {
     if (options.plugin != null)
@@ -32,8 +36,11 @@ class ModuleOptionsStore {
       this.autoImport = options.autoImport;
     if (options.rootDir != null)
       this.rootDir = options.rootDir;
+    if (options.srcDir != null)
+      this.srcDir = options.srcDir;
     if (options.buildDir != null)
       this.buildDir = options.buildDir;
+    this.pagesDir = path.join(this.srcDir, "pages");
     if (options.i18n != null)
       this.i18n = options.i18n;
     if (options.i18nOptions != null) {
@@ -53,6 +60,12 @@ class ModuleOptionsStore {
     if (options.pathCheck != null) {
       this.pathCheck = options.pathCheck;
     }
+    if (options.experimentalIgnoreRoutes) {
+      this.experimentalIgnoreRoutes = options.experimentalIgnoreRoutes;
+    }
+  }
+  get resolvedIgnoredRoutes() {
+    return this.experimentalIgnoreRoutes.map((file) => path.join(this.pagesDir, file));
   }
   getResolvedStrictOptions() {
     let resolved;
@@ -1383,7 +1396,7 @@ function modifyRoutePrefixDefaultIfI18n(route) {
       }
     } else if (i18nOptions?.strategy === "prefix_except_default") {
       let defaultLocale = i18nLocales.find((f) => f === i18nOptions.defaultLocale) ? i18nOptions.defaultLocale?.replace(specialCharacterRegxp, "\\$&") : "";
-      const routeDefaultNameRegXp = new RegExp(`^([a-zA-Z-]+)${separator}${defaultLocale}`, "g");
+      const routeDefaultNameRegXp = new RegExp(`^([a-zA-Z0-9-]+)${separator}${defaultLocale}`, "g");
       const match = routeDefaultNameRegXp.exec(route.name);
       if (match) {
         const [_, routeName] = match;
@@ -1428,6 +1441,9 @@ function walkThoughRoutes({
 }) {
   const route = modifyRoutePrefixDefaultIfI18n(_route);
   const isLocaleRoute = isLocale || is18Sibling(output.routesPaths, route);
+  if (route.file && moduleOptionStore.resolvedIgnoredRoutes.includes(route.file)) {
+    return;
+  }
   const newPath = `${parent?.path ?? ""}${route.path.startsWith("/") || parent?.path === "/" ? route.path : `/${route.path}`}`;
   if (parent?.path !== "/") {
     output.routesPaths.push({
@@ -1527,8 +1543,9 @@ async function createTypedRouter({
 }) {
   try {
     const rootDir = nuxt.options.rootDir;
+    const srcDir = nuxt.options.srcDir;
     const autoImport = nuxt.options.imports.autoImport ?? true;
-    moduleOptionStore.updateOptions({ rootDir, autoImport });
+    moduleOptionStore.updateOptions({ rootDir, autoImport, srcDir });
     if (!isHookCall) {
       if (routesConfig) {
         await nuxt.callHook("pages:extend", routesConfig);
@@ -1626,7 +1643,8 @@ const module = defineNuxtModule({
     plugin: false,
     strict: false,
     pathCheck: true,
-    experimentalRemoveNuxtDefs: true
+    experimentalRemoveNuxtDefs: true,
+    experimentalIgnoreRoutes: []
   },
   setup(moduleOptions, nuxt) {
     const { resolve } = createResolver(import.meta.url);
@@ -1672,6 +1690,14 @@ const module = defineNuxtModule({
         });
       }
     });
+    nuxt.hook("build:done", () => {
+      if (moduleOptions.experimentalRemoveNuxtDefs) {
+        removeNuxtDefinitions({
+          autoImport: nuxt.options.imports.autoImport ?? true,
+          buildDir: nuxt.options.buildDir
+        });
+      }
+    });
     if (nuxt.options.dev) {
       nuxt.hook("devtools:customTabs", (tabs) => {
         tabs.push({

package/package.json

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