nuxt-typed-router 3.1.5 → 3.2.0

package/README.md

@@ -17,8 +17,8 @@
 <img src='https://img.shields.io/npm/l/nuxt-typed-router.svg'>
 
 -----------
-> ⚠️ Nuxt 3.4 introduced a breaking change in its router output
-> Install `v3.1.4` of nuxt-typed-router if you're using this Nuxt version
+> ⚠️ Nuxt 3.4 introduced a breaking change in its router output.  
+> Install a version superior > `v3.1.4` of nuxt-typed-router if you're using this Nuxt version
 -----------
 
 ## Provide a type safe router to Nuxt with auto-generated typed definitions for route path, name and params

package/dist/module.json

@@ -5,5 +5,5 @@
     "nuxt": "^3.0.0",
     "bridge": false
   },
-  "version": "3.1.5"
+  "version": "3.2.0"
 }

package/dist/module.mjs

@@ -38,7 +38,9 @@ class ModuleOptionsStore {
     if (options.i18n != null)
       this.i18n = options.i18n;
     if (options.i18nOptions != null) {
-      this.i18nOptions = options.i18nOptions;
+      this.i18nOptions = defu(options.i18nOptions, {
+        strategy: "prefix_except_default"
+      });
       if (options.i18nOptions.locales) {
         this.i18nLocales = options.i18nOptions.locales.map((l) => {
           if (typeof l === "string") {
@@ -1114,7 +1116,7 @@ function createDefinePageMetaFile() {
     [T in keyof PageMeta as [unknown] extends [PageMeta[T]] ? never : T]: PageMeta[T];
   }
 
-  export type TypedPageMeta<T extends RoutesNamesList> = Omit<FilteredPageMeta, 'redirect' | 'validate' | 'key'> & {
+  export type TypedPageMeta = Omit<FilteredPageMeta, 'redirect' | 'validate' | 'key'> & {
     /**
      * Validate whether a given route can validly be rendered with this page.
      *
@@ -1123,8 +1125,8 @@ function createDefinePageMetaFile() {
      * statusCode/statusMessage to respond immediately with an error (other matches
      * will not be checked).
      */
-    validate?: (route: [T] extends [never] ? TypedRoute : TypedRouteFromName<T>) => boolean | Promise<boolean> | Partial<NuxtError> | Promise<Partial<NuxtError>>;
-    key?: false | string | ((route: [T] extends [never] ? TypedRoute : TypedRouteFromName<T>) => string);
+    validate?: (route: TypedRoute) => boolean | Promise<boolean> | Partial<NuxtError> | Promise<Partial<NuxtError>>;
+    key?: false | string | ((route: TypedRoute) => string);
     /** Allow types augmented by other modules */
     [key: string]: any;
   }
@@ -1147,26 +1149,22 @@ function createDefinePageMetaFile() {
    * @exemple
    * 
    * \`\`\`ts
-   * definePageMeta('current-location-name', {
-   *   validate(route) {
-   * });
-   * // or
    * definePageMeta({
    *   validate(route) {
    * });
    * \`\`\`
    */
 export function definePageMeta<P extends string, U extends RoutesNamesList>(
-  meta: TypedPageMeta<never> & { redirect: TypedRouteLocationRawFromName<U, P> }
+  meta: TypedPageMeta & { redirect: TypedRouteLocationRawFromName<U, P> }
 ): void;
 ${returnIfTrue(
       pathCheck && !strictOptions.router.strictToArgument,
       `export function definePageMeta<P extends string>(
-  meta: TypedPageMeta<never> & { redirect: TypedPathParameter<P> }
+  meta: TypedPageMeta & { redirect: TypedPathParameter<P> }
 ): void;`
     )}
 export function definePageMeta<P extends string = string>(
-  meta: TypedPageMeta<never> & {
+  meta: TypedPageMeta & {
     redirect?: (to: TypedRoute) => TypedRouteLocationRaw<P> ${returnIfTrue(
       pathCheck && !strictOptions.router.strictToArgument,
       ` | TypedPathParameter<P>`
@@ -1174,55 +1172,16 @@ export function definePageMeta<P extends string = string>(
   }
 ): void;
 export function definePageMeta<P extends string = string>(
-  meta: TypedPageMeta<never> & {
+  meta: TypedPageMeta & {
     redirect?: () => TypedRouteLocationRaw<P> ${returnIfTrue(
       pathCheck && !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(
-      pathCheck && !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(
-      pathCheck && !strictOptions.router.strictToArgument,
-      ` | TypedPathParameter<P>`
-    )};
-  }
-): void;
-export function definePageMeta<T extends RoutesNamesList, P extends string>(
-  routeName: T,
-  meta: TypedPageMeta<T> & {
-    redirect?: () => TypedRouteLocationRaw<P> ${returnIfTrue(
-      pathCheck && !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);
-  }
+export function definePageMeta(meta?: TypedPageMeta): void {
+  return defaultDefinePageMeta(meta);
 }
-
    
   `
   );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-typed-router",
-  "version": "3.1.5",
+  "version": "3.2.0",
   "description": "Provide autocompletion for routes paths, names and params in Nuxt apps",
   "type": "module",
   "main": "./dist/module.cjs",
@@ -59,44 +59,44 @@
     "url": "https://github.com/victorgarciaesgi/nuxt-typed-router/issues"
   },
   "dependencies": {
-    "@nuxt/kit": "^3.4.1",
+    "@nuxt/kit": "^3.4.2",
     "chalk": "^5.2.0",
     "defu": "^6.1.2",
     "lodash-es": "^4.17.21",
     "log-symbols": "^5.1.0",
-    "mkdirp": "^3.0.0",
+    "mkdirp": "^3.0.1",
     "nanoid": "^4.0.2",
     "pathe": "1.1.0",
-    "prettier": "2.8.7"
+    "prettier": "2.8.8"
   },
   "devDependencies": {
-    "@nuxt/devtools": "^0.4.0",
+    "@nuxt/devtools": "^0.4.2",
     "@nuxt/module-builder": "^0.3.0",
-    "@nuxt/test-utils": "^3.4.1",
+    "@nuxt/test-utils": "^3.4.2",
     "@nuxt/types": "^2.16.3",
     "@nuxtjs/eslint-config-typescript": "^12.0.0",
-    "@nuxtjs/i18n": "8.0.0-beta.9",
+    "@nuxtjs/i18n": "8.0.0-beta.10",
     "@nuxtjs/web-vitals": "^0.2.4",
     "@types/lodash-es": "^4.17.7",
-    "@types/node": "^18.15.11",
+    "@types/node": "^18.16.1",
     "@types/prettier": "^2.7.2",
-    "@typescript-eslint/eslint-plugin": "^5.58.0",
-    "@typescript-eslint/parser": "^5.58.0",
+    "@typescript-eslint/eslint-plugin": "^5.59.1",
+    "@typescript-eslint/parser": "^5.59.1",
     "@vue/test-utils": "^2.3.2",
     "bumpp": "9.1.0",
-    "changelogithub": "0.12.7",
+    "changelogithub": "0.12.9",
     "cross-env": "^7.0.3",
-    "eslint": "8.38.0",
+    "eslint": "8.39.0",
     "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-vue": "^9.10.0",
-    "nuxt": "3.4.1",
-    "nuxt-seo-kit": "1.3.6",
-    "playwright": "1.32.3",
+    "eslint-plugin-vue": "^9.11.0",
+    "nuxt": "3.4.2",
+    "nuxt-seo-kit": "1.3.7",
+    "playwright": "1.33.0",
     "tsd": "^0.28.1",
     "typescript": "^5.0.4",
     "vitest": "^0.30.1",
     "vue-eslint-parser": "^9.1.1",
     "vue-router": "^4.1.6",
-    "vue-tsc": "^1.1.7"
+    "vue-tsc": "^1.6.0"
   }
 }