nuxt-typed-router 3.0.0-beta.2 → 3.0.0-beta.3

package/dist/module.json

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

package/dist/module.mjs

@@ -584,6 +584,7 @@ function createIndexFile() {
     export { useRouter } from './__useTypedRouter';
     export { navigateTo } from './__navigateTo';
     export { definePageMeta } from './__definePageMeta';
+    export { helpers } from './__helpers';
     
     ${returnIfTrue(
       experimentalPathCheck,
@@ -591,20 +592,7 @@ function createIndexFile() {
     )}
     ${returnIfTrue(i18n, `export {useLocalePath, useLocaleRoute} from './__i18n-router';`)}
 
-    export const helpers = {
-      route(
-        to: TypedRouteLocationRawFromName<T, P>,
-      ): [T] extends [never] ? string : Required<
-        (Omit<Exclude<RouteLocationRaw, string>, 'name' | 'params'> & TypedLocationAsRelativeRaw<T>)
-      > {
-        return to;
-      },
-      path(
-        to: TypedPathParameter<T>,
-      ) : [T] extends [never] ? string : Required<TypedRouteLocationRawFromName<RouteNameFromPath<T>, T>> {
-        return to;
-      }
-    } 
+    
   `
   );
 }
@@ -1025,15 +1013,15 @@ function createDefinePageMetaFile() {
   
   import { definePageMeta as defaultDefinePageMeta } from '#imports';
   import type {PageMeta, NuxtError} from '#app'
-  import type {TypedRouteFromName, TypedRoute, TypedRouteLocationRawFromName} from './__router';
-  import type {RoutesNamesList, RoutesNamedLocations} from './__routes';
+  import type {TypedRouteFromName, TypedRoute, TypedRouteLocationRawFromName, TypedRouteLocationRaw} from './__router';
+  import type {RoutesNamesList} from './__routes';
   ${returnIfTrue(experimentalPathCheck, `import type {TypedPathParameter} from './__paths';`)}
 
   type FilteredPageMeta = {
     [T in keyof PageMeta as [unknown] extends [PageMeta[T]] ? never : T]: PageMeta[T];
   }
 
-  export type TypedPageMeta<T extends RoutesNamesList, P extends string, U extends RoutesNamesList> = Omit<FilteredPageMeta, 'redirect' | 'validate' | 'key'> & {
+  export type TypedPageMeta<T extends RoutesNamesList> = Omit<FilteredPageMeta, 'redirect' | 'validate' | 'key'> & {
     /**
      * Validate whether a given route can validly be rendered with this page.
      *
@@ -1043,22 +1031,6 @@ function createDefinePageMetaFile() {
      * will not be checked).
      */
     validate?: (route: [T] extends [never] ? TypedRoute : TypedRouteFromName<T>) => boolean | Promise<boolean> | Partial<NuxtError> | Promise<Partial<NuxtError>>;
-    /**
-     * Where to redirect if the route is directly matched. The redirection happens
-     * before any navigation guard and triggers a new navigation with the new
-     * target location.
-     */
-    redirect?: 
-     | TypedRouteLocationRawFromName<U, P>
-     | ((to: [T] extends [never] ? TypedRoute : TypedRouteFromName<T>) 
-          => TypedRouteLocationRawFromName<any, P> ${returnIfTrue(
-      experimentalPathCheck && !strictOptions.router.strictToArgument,
-      ` | TypedPathParameter<P>`
-    )})
-     ${returnIfTrue(
-      experimentalPathCheck && !strictOptions.router.strictToArgument,
-      ` | TypedPathParameter<P>`
-    )}
     key?: false | string | ((route: [T] extends [never] ? TypedRoute : TypedRouteFromName<T>) => string);
   }
 
@@ -1067,7 +1039,16 @@ function createDefinePageMetaFile() {
    * Typed clone of \`definePageMeta\`
    * 
    * \u26A0\uFE0F Types for the redirect function may be buggy or not display autocomplete
-   * 
+   * Use \`helpers.route\` or \`helpers.path\` to provide autocomplete.
+   *
+   * \`\`\`ts
+   * import {helpers} from '@typed-router';
+   * definePageMeta({
+   *   redirect(route) {
+   *      return helpers.path('/foo')
+   *   }
+   * });
+   * \`\`\`
    * @exemple
    * 
    * \`\`\`ts
@@ -1080,22 +1061,113 @@ function createDefinePageMetaFile() {
    * });
    * \`\`\`
    */
-  export function definePageMeta<
-    P extends string,
-    U extends RoutesNamesList
-  >(meta: TypedPageMeta<never, P, U>): void;
-  export function definePageMeta<
-    T extends RoutesNamesList,
-    P extends string,
-    U extends RoutesNamesList
-  >(routeName: T, meta: TypedPageMeta<T, P, U>): void;
-  export function definePageMeta(metaOrName: any, meta?: any): void {
-    if (typeof metaOrName === 'string') {
-      return defaultDefinePageMeta(meta as any);
-    } else {
-      return defaultDefinePageMeta(metaOrName as any);
-    }
+export function definePageMeta<P extends string, U extends RoutesNamesList>(
+  meta: TypedPageMeta<never> & { redirect: TypedRouteLocationRawFromName<U, P> }
+): void;
+${returnIfTrue(
+      experimentalPathCheck && !strictOptions.router.strictToArgument,
+      `export function definePageMeta<P extends string>(
+  meta: TypedPageMeta<never> & { redirect: TypedPathParameter<P> }
+): void;`
+    )}
+export function definePageMeta<P extends string = string>(
+  meta: TypedPageMeta<never> & {
+    redirect?: (to: TypedRoute) => TypedRouteLocationRaw<P> ${returnIfTrue(
+      experimentalPathCheck && !strictOptions.router.strictToArgument,
+      ` | TypedPathParameter<P>`
+    )};
+  }
+): void;
+export function definePageMeta<P extends string = string>(
+  meta: TypedPageMeta<never> & {
+    redirect?: () => TypedRouteLocationRaw<P> ${returnIfTrue(
+      experimentalPathCheck && !strictOptions.router.strictToArgument,
+      ` | TypedPathParameter<P>`
+    )};
+  }
+): void;
+export function definePageMeta<
+  T extends RoutesNamesList,
+  P extends string,
+  U extends RoutesNamesList
+>(routeName: T, meta: TypedPageMeta<T> & { redirect: TypedRouteLocationRawFromName<U, P> }): void;
+${returnIfTrue(
+      experimentalPathCheck && !strictOptions.router.strictToArgument,
+      `export function definePageMeta<T extends RoutesNamesList, P extends string>(
+  routeName: T,
+  meta: TypedPageMeta<T> & { redirect: TypedPathParameter<P> }
+): void;`
+    )}
+export function definePageMeta<
+  T extends RoutesNamesList,
+  P extends string,
+  U extends RoutesNamesList
+>(
+  routeName: T,
+  meta: TypedPageMeta<T> & {
+    redirect?: (to: TypedRouteFromName<T>) => TypedRouteLocationRaw<P> ${returnIfTrue(
+      experimentalPathCheck && !strictOptions.router.strictToArgument,
+      ` | TypedPathParameter<P>`
+    )};
   }
+): void;
+export function definePageMeta<T extends RoutesNamesList, P extends string>(
+  routeName: T,
+  meta: TypedPageMeta<T> & {
+    redirect?: () => TypedRouteLocationRaw<P> ${returnIfTrue(
+      experimentalPathCheck && !strictOptions.router.strictToArgument,
+      ` | TypedPathParameter<P>`
+    )};
+  }
+): void;
+export function definePageMeta(metaOrName: any, meta?: any): void {
+  if (typeof metaOrName === 'string') {
+    return defaultDefinePageMeta(meta as any);
+  } else {
+    return defaultDefinePageMeta(metaOrName as any);
+  }
+}
+
+   
+  `
+  );
+}
+
+function createHelpersFile() {
+  const { experimentalPathCheck } = moduleOptionStore;
+  return (
+    /* typescript */
+    `
+  
+  
+
+  import type { RouteLocationRaw } from 'vue-router';
+  import type { TypedRouteLocationRawFromName, TypedLocationAsRelativeRaw } from './__router';
+  import type { RoutesNamesList } from './__routes';
+  ${returnIfTrue(
+      experimentalPathCheck,
+      `import type {TypedPathParameter, RouteNameFromPath} from './__paths';`
+    )}
+
+export const helpers = {
+  route<T extends RoutesNamesList = never, P extends string = never>(
+    to: TypedRouteLocationRawFromName<T, P>
+  ): [T] extends [never]
+    ? string
+    : Required<
+        Omit<Exclude<RouteLocationRaw, string>, 'name' | 'params'> & TypedLocationAsRelativeRaw<T>
+      > {
+    return to as any;
+  },
+  path<T extends string = never>(
+    to: TypedPathParameter<T>
+  ): [T] extends [never]
+    ? string
+    : Required<TypedRouteLocationRawFromName<RouteNameFromPath<T>, T>> {
+    return to as any;
+  },
+};
+
    
   `
   );
@@ -1203,6 +1275,10 @@ async function saveGeneratedFiles({ outputData }) {
       fileName: `__routes.ts`,
       content: createRoutesTypesFile(outputData)
     },
+    {
+      fileName: `__helpers.ts`,
+      content: createHelpersFile()
+    },
     {
       fileName: "__navigateTo.ts",
       content: createNavigateToFile()
@@ -1490,7 +1566,7 @@ const module = defineNuxtModule({
       "@typed-router": resolve(`${rootDir}/.nuxt/typed-router`)
     };
     nuxt.hook("prepare:types", (options) => {
-      options.tsConfig.include?.push("./typed-router/typed-router.d.ts");
+      options.tsConfig.include?.unshift("./typed-router/typed-router.d.ts");
       if (moduleOptions.experimentalPathCheck) {
         options.tsConfig.vueCompilerOptions = {
           jsxTemplates: true,

package/package.json

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