nuxt-typed-router 3.3.3 → 3.4.0

package/README.md

@@ -60,8 +60,6 @@ Demo repo 🧪 : [nuxt-typed-router-demo](https://github.com/victorgarciaesgi/nu
 # Compatibility:
 
 - Nuxt 3
-- Nuxt 2 (via [`nuxt2` branch](https://github.com/victorgarciaesgi/nuxt-typed-router/tree/nuxt2))
-
 
 
 # Quick start
@@ -76,16 +74,6 @@ npm install -D nuxt-typed-router
 pnpm install -D nuxt-typed-router
 ```
 
-### Nuxt 2 legacy (not maintained)
-
-Nuxt 2 version is no longer maintained, but still available in [`nuxt2` branch](https://github.com/victorgarciaesgi/nuxt-typed-router/tree/nuxt2)
-It only has route name autocomplete functionnality
-
-```bash
-yarn add -D nuxt-typed-router@legacy
-# or
-npm install -D nuxt-typed-router@legacy
-```
 
 # Configuration
 Register the module in the `nuxt.config.ts`, done!

package/dist/module.d.mts

@@ -27,14 +27,14 @@ interface ModuleOptions {
      * Remove Nuxt definitions to avoid conflicts
      * @default true
      */
-    experimentalRemoveNuxtDefs?: boolean;
+    removeNuxtDefs?: boolean;
     /**
      * ⚠️ Experimental
      *
      * Exclude certain routes from being included into the generated types
      * Ex: 404 routes or catchAll routes
      */
-    experimentalIgnoreRoutes?: string[];
+    ignoreRoutes?: string[];
 }
 interface StrictOptions {
     NuxtLink?: StrictParamsOptions;

package/dist/module.d.ts

@@ -27,14 +27,14 @@ interface ModuleOptions {
      * Remove Nuxt definitions to avoid conflicts
      * @default true
      */
-    experimentalRemoveNuxtDefs?: boolean;
+    removeNuxtDefs?: boolean;
     /**
      * ⚠️ Experimental
      *
      * Exclude certain routes from being included into the generated types
      * Ex: 404 routes or catchAll routes
      */
-    experimentalIgnoreRoutes?: string[];
+    ignoreRoutes?: string[];
 }
 interface StrictOptions {
     NuxtLink?: StrictParamsOptions;

package/dist/module.json

@@ -5,5 +5,5 @@
     "nuxt": "^3.0.0",
     "bridge": false
   },
-  "version": "3.3.3"
+  "version": "3.4.0"
 }

package/dist/module.mjs

@@ -24,7 +24,7 @@ class ModuleOptionsStore {
   i18n = false;
   i18nOptions = null;
   i18nLocales = [];
-  experimentalIgnoreRoutes = [];
+  ignoreRoutes = [];
   updateOptions(options) {
     if (options.plugin != null)
       this.plugin = options.plugin;
@@ -58,12 +58,12 @@ class ModuleOptionsStore {
     if (options.pathCheck != null) {
       this.pathCheck = options.pathCheck;
     }
-    if (options.experimentalIgnoreRoutes) {
-      this.experimentalIgnoreRoutes = options.experimentalIgnoreRoutes;
+    if (options.ignoreRoutes) {
+      this.ignoreRoutes = options.ignoreRoutes;
     }
   }
   get resolvedIgnoredRoutes() {
-    return this.experimentalIgnoreRoutes.map((file) => path.join(this.pagesDir, file));
+    return this.ignoreRoutes.map((file) => path.join(this.pagesDir, file));
   }
   getResolvedStrictOptions() {
     let resolved;
@@ -358,6 +358,19 @@ function createTypedRouterFile() {
 
   // - Routes location for navigation types (ex: router.push or navigateTo)
 
+
+  export type NuxtRoute<T extends RoutesNamesList, P extends string, E extends boolean = false> = 
+    | TypedRouteLocationRawFromName<T, P>
+    ${returnIfTrue(!pathCheck && !strictOptions.NuxtLink.strictToArgument, ` | string`)}
+    ${returnIfTrue(
+      pathCheck && strictOptions.NuxtLink.strictToArgument,
+      ` | (E extends true ? string : never)`
+    )}
+    ${returnIfTrue(
+      pathCheck && !strictOptions.NuxtLink.strictToArgument,
+      ` | (E extends true ? string : TypedPathParameter<P>)`
+    )}
+
   /** 
    * RouteLocationRaw with discrimanated name and params properties 
    * {@link RouteLocationRaw}
@@ -460,22 +473,14 @@ function createTypedRouterFile() {
      *
      * @param to - Route location to navigate to
      */
-    push<T extends RoutesNamesList, P extends string>(to: TypedRouteLocationRawFromName<T, P>): Promise<NavigationFailure | void | undefined>;
-    ${returnIfTrue(
-      pathCheck && !strictOptions.router.strictToArgument,
-      `push<T extends string>(to: TypedPathParameter<T>): Promise<NavigationFailure | void | undefined>;`
-    )}
+    push<T extends RoutesNamesList, P extends string>(to: NuxtRoute<T, P>): Promise<NavigationFailure | void | undefined>;
     /**
      * Programmatically navigate to a new URL by replacing the current entry in
      * the history stack.
      *
      * @param to - Route location to navigate to
      */
-    replace<T extends RoutesNamesList, P extends string>(to: TypedRouteLocationRawFromName<T, P>): Promise<NavigationFailure | void | undefined>;
-    ${returnIfTrue(
-      pathCheck && !strictOptions.router.strictToArgument,
-      `replace<T extends string>(to: TypedPathParameter<T>): Promise<NavigationFailure | void | undefined>;`
-    )}
+    replace<T extends RoutesNamesList, P extends string>(to: NuxtRoute<T, P>): Promise<NavigationFailure | void | undefined>;
   }
 
   
@@ -520,24 +525,25 @@ function createTypedRouterFile() {
 }
 
 function createTypedRouterDefinitionFile() {
-  const strictOptions = moduleOptionStore.getResolvedStrictOptions();
+  moduleOptionStore.getResolvedStrictOptions();
   const { plugin, autoImport, i18n, pathCheck } = moduleOptionStore;
   return (
     /* typescript */
     `
     
-    import type { NuxtLinkProps, PageMeta } from '#app';
+    import type { NuxtLinkProps, PageMeta } from 'nuxt/app';
     import NuxtLink from 'nuxt/dist/app/components/nuxt-link';
     import type { RouteLocationRaw, RouteLocationPathRaw } from 'vue-router';
     import type { RoutesNamedLocations, RoutesNamesListRecord, RoutesNamesList } from './__routes';
-    import type {TypedRouter, TypedRoute, TypedRouteLocationRawFromName, TypedLocationAsRelativeRaw} from './__router';
+    import type {TypedRouter, TypedRoute, TypedRouteLocationRawFromName, TypedLocationAsRelativeRaw, NuxtRoute} from './__router';
     import { useRoute as _useRoute } from './__useTypedRoute';
     import { useRouter as _useRouter } from './__useTypedRouter';
     import { useLink as _useLink } from './__useTypedLink';
     import { navigateTo as _navigateTo } from './__navigateTo';
     ${returnIfTrue(
       i18n,
-      `import { useLocalePath as _useLocalePath, useLocaleRoute as _useLocaleRoute} from './__i18n-router';`
+      `import { useLocalePath as _useLocalePath, useLocaleRoute as _useLocaleRoute} from './__i18n-router';
+      import type {TypedNuxtLinkLocale} from './__NuxtLinkLocale'`
     )}
 
     import {definePageMeta as _definePageMeta} from './__definePageMeta';
@@ -569,40 +575,28 @@ function createTypedRouterDefinitionFile() {
     )}
     }
     
-    type TypedNuxtLinkProps<T extends string, E extends boolean = false> = Omit<NuxtLinkProps, 'to' | 'external'> &
+    type TypedNuxtLinkProps<
+    T extends RoutesNamesList,
+    P extends string,
+    E extends boolean = false> = Omit<NuxtLinkProps, 'to' | 'external'> &
      {
-      to: 
-        | Omit<Exclude<RouteLocationRaw, string>, 'name' | 'params'> & RoutesNamedLocations
-        | Omit<RouteLocationPathRaw, 'path'>
-        ${returnIfTrue(
-      pathCheck && !strictOptions.NuxtLink.strictRouteLocation,
-      `& {path?: (E extends true ? string : TypedPathParameter<T>)}`
-    )}
-        ${returnIfTrue(!pathCheck && !strictOptions.NuxtLink.strictToArgument, ` | string`)}
-        ${returnIfTrue(
-      pathCheck && strictOptions.NuxtLink.strictToArgument,
-      ` | (E extends true ? string : void)`
-    )}
-        ${returnIfTrue(
-      pathCheck && !strictOptions.NuxtLink.strictToArgument,
-      ` | (E extends true ? string : TypedPathParameter<T>)`
-    )},
+      to: NuxtRoute<T, P, E>,
       external?: E
       }
     
         
           
-    export type TypedNuxtLink = new <P extends string, E extends boolean = false>(props: TypedNuxtLinkProps<P, E>) => Omit<
+    export type TypedNuxtLink = new <T extends RoutesNamesList, P extends string, E extends boolean = false>(props: TypedNuxtLinkProps<T, P, E>) => Omit<
       typeof NuxtLink,
       '$props'
     > & {
-      $props: TypedNuxtLinkProps<P, E>;
+      $props: TypedNuxtLinkProps<T, P, E>;
     };
     
-    // Declare runtime-core instead of vue for compatibility issues with pnpm
     declare module 'vue' {
       interface GlobalComponents {
         NuxtLink: TypedNuxtLink;
+        ${returnIfTrue(i18n, ` NuxtLinkLocale: TypedNuxtLinkLocale;`)}
       }
     }
 
@@ -644,6 +638,7 @@ function createIndexFile() {
       TypedRouteLocationRaw,
       TypedRouteLocationRawFromName,
       TypedRouter,
+      NuxtRoute
     } from './__router';
     export { routesNames } from './__routes';
     export type {
@@ -908,7 +903,7 @@ function createTypeUtilsRuntimeFile() {
 }
 
 function createi18nRouterFile() {
-  const { router } = moduleOptionStore.getResolvedStrictOptions();
+  const { router, NuxtLink } = moduleOptionStore.getResolvedStrictOptions();
   const { i18nOptions, pathCheck, i18nLocales } = moduleOptionStore;
   const LocalePathType = i18nOptions?.strategy === "no_prefix" ? "TypedPathParameter" : "TypedLocalePathParameter";
   return (
@@ -925,6 +920,16 @@ function createi18nRouterFile() {
 
   export type I18nLocales = ${i18nLocales?.length ? i18nLocales.map((loc) => `"${loc}"`).join("|") : "string"};
 
+
+  export type NuxtLocaleRoute<T extends RoutesNamesList, P extends string, E extends boolean = false> = 
+    | TypedRouteLocationRawFromName<T, P>
+    ${returnIfTrue(!pathCheck && !NuxtLink.strictToArgument, ` | string`)}
+    ${returnIfTrue(pathCheck && NuxtLink.strictToArgument, ` | (E extends true ? string : never)`)}
+    ${returnIfTrue(
+      pathCheck && !NuxtLink.strictToArgument,
+      ` | (E extends true ? string : ${LocalePathType}<P>)`
+    )}
+
   export interface TypedToLocalePath {
     <T extends RoutesNamesList, P extends string>(
       to: TypedRouteLocationRawFromName<T, P>,
@@ -1181,7 +1186,7 @@ function createDefinePageMetaFile() {
     `
   
   import { definePageMeta as defaultDefinePageMeta } from '#imports';
-  import type {PageMeta, NuxtError} from '#app'
+  import type {PageMeta, NuxtError} from 'nuxt/app'
   import type {TypedRouteFromName, TypedRoute, TypedRouteLocationRawFromName, TypedRouteLocationRaw} from './__router';
   import type {RoutesNamesList} from './__routes';
   ${returnIfTrue(pathCheck, `import type {TypedPathParameter} from './__paths';`)}
@@ -1301,6 +1306,40 @@ export const helpers = {
   );
 }
 
+function createNuxtLinkLocaleDefinitionFile() {
+  moduleOptionStore.getResolvedStrictOptions();
+  return (
+    /* typescript */
+    `
+    
+    import type { NuxtLinkProps, PageMeta } from 'nuxt/app';
+    import NuxtLink from 'nuxt/dist/app/components/nuxt-link';
+    import type { RoutesNamedLocations, RoutesNamesListRecord, RoutesNamesList } from './__routes';
+    import type {TypedRouter, TypedRoute, TypedRouteLocationRawFromName, TypedLocationAsRelativeRaw} from './__router';
+    import type {NuxtLocaleRoute, I18nLocales} from './__i18n-router';
+    
+    
+    type TypedNuxtLinkLocaleProps<
+    T extends RoutesNamesList,
+    P extends string,
+    E extends boolean = false> = Omit<NuxtLinkProps, 'to' | 'external'> &
+     {
+      to: NuxtLocaleRoute<T, P, E>,
+      external?: E,
+      locale?: E extends true ? never : I18nLocales
+      }
+    
+    export type TypedNuxtLinkLocale = new <T extends RoutesNamesList, P extends string, E extends boolean = false>(props: TypedNuxtLinkLocaleProps<T, P, E>) => Omit<
+      typeof NuxtLink,
+      '$props'
+    > & {
+      $props: TypedNuxtLinkLocaleProps<T, P, E>;
+    };
+    
+  `
+  );
+}
+
 async function handleAddPlugin() {
   const pluginName = "__typed-router.plugin.ts";
   addPluginTemplate({
@@ -1412,6 +1451,10 @@ async function saveGeneratedFiles({ outputData }) {
       fileName: "__i18n-router.ts",
       content: createi18nRouterFile()
     });
+    filesMap.push({
+      fileName: "__NuxtLinkLocale.ts",
+      content: createNuxtLinkLocaleDefinitionFile()
+    });
   }
   await Promise.all(
     filesMap.map(({ content, fileName }) => {
@@ -1667,7 +1710,7 @@ async function removeNuxtDefinitions({
       encoding: "utf8"
     });
     const replacedNuxtLink = componentDefinitions.replace(
-      /'NuxtLink': typeof import\(".*"\)\['default'\]/gm,
+      /'NuxtLink': typeof import\(".*"\)\['default'\]|'NuxtLinkLocale': typeof import\(".*"\)\['default'\]/gm,
       ""
     );
     processPathAndWriteFile({
@@ -1712,8 +1755,8 @@ const module = defineNuxtModule({
     plugin: false,
     strict: false,
     pathCheck: true,
-    experimentalRemoveNuxtDefs: true,
-    experimentalIgnoreRoutes: []
+    removeNuxtDefs: true,
+    ignoreRoutes: []
   },
   setup(moduleOptions, nuxt) {
     const { resolve } = createResolver(import.meta.url);
@@ -1752,7 +1795,7 @@ const module = defineNuxtModule({
           experimentalRfc436: true
         };
       }
-      if (moduleOptions.experimentalRemoveNuxtDefs) {
+      if (moduleOptions.removeNuxtDefs) {
         removeNuxtDefinitions({
           autoImport: nuxt.options.imports.autoImport ?? true,
           buildDir: nuxt.options.buildDir
@@ -1760,7 +1803,7 @@ const module = defineNuxtModule({
       }
     });
     nuxt.hook("build:done", () => {
-      if (moduleOptions.experimentalRemoveNuxtDefs) {
+      if (moduleOptions.removeNuxtDefs) {
         removeNuxtDefinitions({
           autoImport: nuxt.options.imports.autoImport ?? true,
           buildDir: nuxt.options.buildDir

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-typed-router",
-  "version": "3.3.3",
+  "version": "3.4.0",
   "description": "Provide autocompletion for routes paths, names and params in Nuxt apps",
   "type": "module",
   "main": "./dist/module.cjs",
@@ -60,41 +60,41 @@
     "url": "https://github.com/victorgarciaesgi/nuxt-typed-router/issues"
   },
   "dependencies": {
-    "@nuxt/kit": "3.8.1",
+    "@nuxt/kit": "3.8.2",
     "chalk": "5.3.0",
     "defu": "6.1.3",
     "lodash-es": "4.17.21",
-    "log-symbols": "5.1.0",
+    "log-symbols": "6.0.0",
     "mkdirp": "3.0.1",
     "nanoid": "5.0.3",
     "pathe": "1.1.1"
   },
   "devDependencies": {
-    "@nuxt/devtools": "1.0.0",
+    "@nuxt/devtools": "1.0.3",
     "@nuxt/module-builder": "0.5.4",
     "@nuxt/test-utils": "3.8.1",
     "@nuxt/types": "2.17.2",
     "@nuxtjs/eslint-config-typescript": "12.1.0",
-    "@nuxtjs/i18n": "8.0.0-beta.10",
+    "@nuxtjs/i18n": "8.0.0-rc.5",
     "@nuxtjs/web-vitals": "0.2.6",
-    "@types/lodash-es": "4.17.11",
-    "@types/node": "20.9.0",
+    "@types/lodash-es": "4.17.12",
+    "@types/node": "20.10.0",
     "@types/prettier": "3.0.0",
-    "@typescript-eslint/eslint-plugin": "6.10.0",
-    "@typescript-eslint/parser": "6.10.0",
-    "@vue/test-utils": "2.4.1",
+    "@typescript-eslint/eslint-plugin": "6.12.0",
+    "@typescript-eslint/parser": "6.12.0",
+    "@vue/test-utils": "2.4.2",
     "bumpp": "9.2.0",
     "changelogithub": "0.13.2",
     "cross-env": "7.0.3",
-    "eslint": "8.53.0",
+    "eslint": "8.54.0",
     "eslint-config-prettier": "9.0.0",
     "eslint-plugin-vue": "9.18.1",
-    "nuxt": "3.8.1",
+    "nuxt": "3.8.2",
     "nuxt-seo-kit": "1.3.13",
     "playwright": "1.37.0",
-    "prettier": "3.0.3",
+    "prettier": "3.1.0",
     "tsd": "0.29.0",
-    "typescript": "5.2.2",
+    "typescript": "5.3.2",
     "vitest": "0.34.6",
     "vue-eslint-parser": "9.3.2",
     "vue-router": "4.2.5",