nuxt-typed-router 3.3.1 → 3.3.3

package/dist/module.d.mts

@@ -0,0 +1,84 @@
+import * as _nuxt_schema from '@nuxt/schema';
+
+interface ModuleOptions {
+    /**
+     *
+     * Enables path autocomplete and path validity for programmatic validation
+     *
+     *  @default true
+     */
+    pathCheck?: boolean;
+    /**
+     * Set to false if you don't want a plugin generated
+     * @default false
+     */
+    plugin?: boolean;
+    /**
+     * Customise Route location arguments strictness for `NuxtLink` or `router`
+     * All strict options are disabled by default.
+     * You can tweak options to add strict router navigation options.
+     *
+     * By passing `true` you can enable all of them
+     *
+     * @default false
+     */
+    strict?: boolean | StrictOptions;
+    /**
+     * Remove Nuxt definitions to avoid conflicts
+     * @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;
+    router?: StrictParamsOptions;
+}
+interface StrictParamsOptions {
+    /**
+     * Prevent passing string path to the RouteLocation argument.
+     *
+     * Ex:
+     * ```vue
+     * <template>
+     *   <NuxtLink to='/login'/> // Error ❌
+     * </template>
+     * ```
+     * Or
+     * ```ts
+     * router.push('/login'); // Error ❌
+     * navigateTo('/login'); // Error ❌
+     * ```
+     *
+     * @default false
+     */
+    strictToArgument?: boolean;
+    /**
+     * Prevent passing a `params` property in the RouteLocation argument.
+     *
+     * Ex:
+     * ```vue
+     * <template>
+     *   <NuxtLink :to='{path: "/login"}'/> // Error ❌
+     * </template>
+     * ```
+     * Or
+     * ```ts
+     * router.push({path: "/login"}); // Error ❌
+     * navigateTo({path: "/login"}); // Error ❌
+     * ```
+     *
+     * @default false
+     */
+    strictRouteLocation?: boolean;
+}
+
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
+
+export { type ModuleOptions, _default as default };

package/dist/module.d.ts

@@ -81,4 +81,4 @@ interface StrictParamsOptions {
 
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
 
-export { ModuleOptions, _default as default };
+export { type ModuleOptions, _default as default };

package/dist/module.json

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

package/dist/module.mjs

@@ -13,20 +13,18 @@ import { camelCase } from 'lodash-es';
 import { readFile } from 'fs/promises';
 
 class ModuleOptionsStore {
-  constructor() {
-    this.plugin = false;
-    this.strict = false;
-    this.pathCheck = true;
-    this.autoImport = false;
-    this.rootDir = "";
-    this.buildDir = "";
-    this.srcDir = "";
-    this.pagesDir = "";
-    this.i18n = false;
-    this.i18nOptions = null;
-    this.i18nLocales = [];
-    this.experimentalIgnoreRoutes = [];
-  }
+  plugin = false;
+  strict = false;
+  pathCheck = true;
+  autoImport = false;
+  rootDir = "";
+  buildDir = "";
+  srcDir = "";
+  pagesDir = "";
+  i18n = false;
+  i18nOptions = null;
+  i18nLocales = [];
+  experimentalIgnoreRoutes = [];
   updateOptions(options) {
     if (options.plugin != null)
       this.plugin = options.plugin;
@@ -214,7 +212,7 @@ function createLocaleRoutePathSchema(routePaths) {
     ${routePaths.filter((f) => !!f.path && !f.isLocale).map((route) => `"${route.path}"`).join("|")}
   `;
 }
-function createValidatePathTypes(pathElements, withLocale = false) {
+function createValidatePathTypes(pathElements, routesList, withLocale = false) {
   let pathConditions = pathElements.map(createTypeValidatePathCondition).filter((f) => {
     if (withLocale) {
       return !f.isLocale;
@@ -237,14 +235,14 @@ function createValidatePathTypes(pathElements, withLocale = false) {
       : ${pathConditions.length ? `\`Error: \${${pathConditions.map((t) => `${t.typeName}<T>`).join("|")}}\`` : "never"}
       : never;
   
-  
+    // RouteNameFromPath, RouteNameFromLocalePath
     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"} 
+         ${pathConditions.length ? `: ${pathConditions.filter((f) => routesList.includes(f.routeName)).map((t) => `${t.typeName}<T> extends true ? "${t.routeName}"`).join(": ")} : never` : ": never"} 
        : never; 
   
         `;
@@ -535,6 +533,7 @@ function createTypedRouterDefinitionFile() {
     import type {TypedRouter, TypedRoute, TypedRouteLocationRawFromName, TypedLocationAsRelativeRaw} 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,
@@ -554,6 +553,7 @@ function createTypedRouterDefinitionFile() {
       `
             const useRoute: typeof _useRoute;
             const useRouter: typeof _useRouter;
+            const useLink: typeof _useLink;
             const navigateTo: typeof _navigateTo;
             const definePageMeta: typeof _definePageMeta;
             
@@ -655,6 +655,7 @@ function createIndexFile() {
     } from './__routes';
     export { useRoute } from './__useTypedRoute';
     export { useRouter } from './__useTypedRouter';
+    export { useLink } from './__useTypedLink';
     export { navigateTo } from './__navigateTo';
     export { definePageMeta } from './__definePageMeta';
     export { helpers } from './__helpers';
@@ -682,7 +683,7 @@ function createPluginFile() {
     /* typescript */
     `
   
-  import { defineNuxtPlugin, useRouter, useRoute } from '#app';
+  import { defineNuxtPlugin, useRouter, useRoute } from '#imports';
   import {TypedRouter, TypedRoute, routesNames} from '@typed-router';
 
   export default defineNuxtPlugin(() => {
@@ -705,7 +706,7 @@ function createUseTypedRouteFile() {
   return (
     /* typescript */
     `
-  import { useRoute as defaultRoute } from '#app';
+  import { useRoute as defaultRoute } from '#imports';
   import type { RoutesNamesList } from './__routes';
   import type {TypedRoute, TypedRouteFromName} from './__router'
 
@@ -746,7 +747,7 @@ function createUseTypedRouterFile() {
     /* typescript */
     `
   
-  import { useRouter as defaultRouter } from '#app';
+  import { useRouter as defaultRouter } from '#imports';
   import type { TypedRouter } from './__router';
 
   /** 
@@ -768,13 +769,76 @@ function createUseTypedRouterFile() {
   );
 }
 
+function createUseTypedLinkFile() {
+  const strictOptions = moduleOptionStore.getResolvedStrictOptions();
+  const { pathCheck } = moduleOptionStore;
+  return (
+    /* typescript */
+    `
+  
+  import { useLink as defaultLink } from '#imports';
+  import type {MaybeRef} from 'vue';
+  import type { NavigateToOptions } from 'nuxt/dist/app/composables/router';
+  import type { NavigationFailure } from 'vue-router';
+  import type { TypedRouteLocationRawFromName, TypedRouteFromName, TypedRoute } from './__router';
+  import type { RoutesNamesList } from './__routes';
+  ${returnIfTrue(
+      pathCheck,
+      `import type {TypedPathParameter, RouteNameFromPath} from './__paths';`
+    )}
+
+
+  type LinkedRoute<T extends RoutesNamesList> = {
+    route: ComputedRef<TypedRouteFromName<T> & {
+        href: string;
+    }>;
+    href: ComputedRef<string>;
+    isActive: ComputedRef<boolean>;
+    isExactActive: ComputedRef<boolean>;
+    navigate: (e?: MouseEvent) => Promise<void | NavigationFailure>;
+};
+
+
+  interface UseLinkFunction {
+    <T extends RoutesNamesList, P extends string>(
+     props: { 
+      to: MaybeRef<TypedRouteLocationRawFromName<T, P>>,
+      replace?: MaybeRef<boolean>
+    }
+    ) : LinkedRoute<T>
+    ${returnIfTrue(
+      pathCheck && !strictOptions.router.strictToArgument,
+      `<T extends string>(
+       props: {
+        to: MaybeRef<TypedPathParameter<T>>,
+        replace?: MaybeRef<boolean>
+       }
+      ) : LinkedRoute<RouteNameFromPath<T>>`
+    )}
+  }
+
+  /** 
+   * Typed clone of \`useLink\`
+   * 
+   * @exemple
+   * 
+   * \`\`\`ts
+   * const router = useLink(props);
+   * \`\`\`
+   */
+  export const useLink: UseLinkFunction = defaultLink as any;
+
+  `
+  );
+}
+
 function createNavigateToFile() {
   const { router } = moduleOptionStore.getResolvedStrictOptions();
   const { pathCheck } = moduleOptionStore;
   return (
     /* typescript */
     `
-    import { navigateTo as defaultNavigateTo } from '#app';
+    import { navigateTo as defaultNavigateTo } from '#imports';
     import type { NavigateToOptions } from 'nuxt/dist/app/composables/router';
     import type { NavigationFailure } from 'vue-router';
     import type { TypedRouteLocationRawFromName, TypedRouteFromName, TypedRoute } from './__router';
@@ -812,7 +876,8 @@ function createNavigateToFile() {
       ) : Promise<void | NavigationFailure | TypedRouteFromName<RouteNameFromPath<T>>>`
     )}
   }
-    export const navigateTo: NavigateToFunction = defaultNavigateTo as any;
+  
+  export const navigateTo: NavigateToFunction = defaultNavigateTo as any;
 
   `
   );
@@ -994,7 +1059,7 @@ function extractPathElements(partOfPath, route) {
   return { pathElements, strippedPath };
 }
 
-function createPathsFiles({ routesPaths }) {
+function createPathsFiles({ routesPaths, routesList }) {
   const { i18n, i18nOptions } = moduleOptionStore;
   const hasPrefixStrategy = i18n && i18nOptions?.strategy !== "no_prefix";
   const filteredRoutesPaths = routesPaths.filter((route) => !routesPaths.find((r) => `${route.path}/` === r.path)).map((route) => ({
@@ -1042,8 +1107,8 @@ function createPathsFiles({ routesPaths }) {
   const pathElements = filteredRoutesPaths.filter((f) => f.path && f.path !== "/").map((route) => {
     return route.path.split("/").filter((f) => f.length).map((m) => destructurePath(m, route));
   }).filter((f) => f.length);
-  const validatePathTypes = createValidatePathTypes(pathElements);
-  const validateLocalePathTypes = createValidatePathTypes(pathElements, true);
+  const validatePathTypes = createValidatePathTypes(pathElements, routesList);
+  const validateLocalePathTypes = createValidatePathTypes(pathElements, routesList, true);
   return (
     /* typescript */
     `
@@ -1301,6 +1366,10 @@ async function saveGeneratedFiles({ outputData }) {
       fileName: "__useTypedRoute.ts",
       content: createUseTypedRouteFile()
     },
+    {
+      fileName: "__useTypedLink.ts",
+      content: createUseTypedLinkFile()
+    },
     {
       fileName: "__paths.d.ts",
       content: createPathsFiles(outputData)
@@ -1445,7 +1514,7 @@ function walkThoughRoutes({
     return;
   }
   const newPath = `${parent?.path ?? ""}${route.path.startsWith("/") || parent?.path === "/" ? route.path : `/${route.path}`}`;
-  if (parent?.path !== "/") {
+  if (parent?.path !== "/" || newPath !== parent?.path) {
     output.routesPaths.push({
       name: route.name,
       path: newPath,

package/dist/types.d.mts

@@ -0,0 +1,16 @@
+
+import type { ModuleOptions } from './module'
+
+
+declare module '@nuxt/schema' {
+  interface NuxtConfig { ['nuxtTypedRouter']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['nuxtTypedRouter']?: ModuleOptions }
+}
+
+declare module 'nuxt/schema' {
+  interface NuxtConfig { ['nuxtTypedRouter']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['nuxtTypedRouter']?: ModuleOptions }
+}
+
+
+export type { ModuleOptions, default } from './module'

package/dist/types.d.ts

@@ -1,5 +1,6 @@
 
-import { ModuleOptions } from './module'
+import type { ModuleOptions } from './module'
+
 
 declare module '@nuxt/schema' {
   interface NuxtConfig { ['nuxtTypedRouter']?: Partial<ModuleOptions> }
@@ -12,4 +13,4 @@ declare module 'nuxt/schema' {
 }
 
 
-export { ModuleOptions, default } from './module'
+export type { ModuleOptions, default } from './module'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-typed-router",
-  "version": "3.3.1",
+  "version": "3.3.3",
   "description": "Provide autocompletion for routes paths, names and params in Nuxt apps",
   "type": "module",
   "main": "./dist/module.cjs",
@@ -15,11 +15,11 @@
     "dist"
   ],
   "scripts": {
-    "prepack": "nuxt-module-build",
+    "prepack": "nuxt-module-build build",
     "dev": "nuxi dev playground",
     "dev:build": "nuxi build playground",
     "prepare:playground": "nuxi prepare playground",
-    "dev:prepare": "nuxt-module-build --stub && nuxi prepare playground && pnpm run test:prepare-fixtures",
+    "dev:prepare": "nuxt-module-build build --stub && nuxi prepare playground && pnpm run test:prepare-fixtures",
     "build:test": "cross-env NUXT_BUILD_TYPE=stub pnpm run prepack && pnpm run dev:build",
     "test:prepare-fixtures": "nuxi prepare test/fixtures/simple && nuxi prepare test/fixtures/withOptions && nuxi prepare test/fixtures/complex",
     "test:fixtures": "vitest run --dir test",
@@ -60,44 +60,44 @@
     "url": "https://github.com/victorgarciaesgi/nuxt-typed-router/issues"
   },
   "dependencies": {
-    "@nuxt/kit": "^3.6.5",
-    "chalk": "^5.3.0",
-    "defu": "^6.1.2",
-    "lodash-es": "^4.17.21",
-    "log-symbols": "^5.1.0",
-    "mkdirp": "^3.0.1",
-    "nanoid": "^4.0.2",
+    "@nuxt/kit": "3.8.1",
+    "chalk": "5.3.0",
+    "defu": "6.1.3",
+    "lodash-es": "4.17.21",
+    "log-symbols": "5.1.0",
+    "mkdirp": "3.0.1",
+    "nanoid": "5.0.3",
     "pathe": "1.1.1"
   },
   "devDependencies": {
-    "@nuxt/devtools": "^0.8.0",
-    "@nuxt/module-builder": "^0.4.0",
-    "@nuxt/test-utils": "^3.6.5",
-    "@nuxt/types": "^2.17.1",
-    "@nuxtjs/eslint-config-typescript": "^12.0.0",
+    "@nuxt/devtools": "1.0.0",
+    "@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/web-vitals": "^0.2.6",
-    "@types/lodash-es": "^4.17.8",
-    "@types/node": "^20.5.0",
-    "@types/prettier": "^3.0.0",
-    "@typescript-eslint/eslint-plugin": "^6.4.0",
-    "@typescript-eslint/parser": "^6.4.0",
-    "@vue/test-utils": "^2.4.1",
-    "bumpp": "9.1.1",
-    "changelogithub": "0.12.12",
-    "cross-env": "^7.0.3",
-    "eslint": "8.47.0",
-    "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-vue": "^9.17.0",
-    "nuxt": "3.6.5",
-    "nuxt-seo-kit": "1.3.9",
+    "@nuxtjs/web-vitals": "0.2.6",
+    "@types/lodash-es": "4.17.11",
+    "@types/node": "20.9.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",
+    "bumpp": "9.2.0",
+    "changelogithub": "0.13.2",
+    "cross-env": "7.0.3",
+    "eslint": "8.53.0",
+    "eslint-config-prettier": "9.0.0",
+    "eslint-plugin-vue": "9.18.1",
+    "nuxt": "3.8.1",
+    "nuxt-seo-kit": "1.3.13",
     "playwright": "1.37.0",
-    "prettier": "3.0.2",
-    "tsd": "^0.28.1",
-    "typescript": "^5.1.6",
-    "vitest": "^0.34.2",
-    "vue-eslint-parser": "^9.3.1",
-    "vue-router": "^4.2.4",
-    "vue-tsc": "^1.8.8"
+    "prettier": "3.0.3",
+    "tsd": "0.29.0",
+    "typescript": "5.2.2",
+    "vitest": "0.34.6",
+    "vue-eslint-parser": "9.3.2",
+    "vue-router": "4.2.5",
+    "vue-tsc": "1.8.22"
   }
 }