nuxt-typed-router 2.2.2-beta.0 → 2.2.2-beta.2

package/dist/module.d.ts

@@ -7,26 +7,54 @@ interface ModuleOptions {
      */
     plugin?: boolean;
     /**
-     * Prevent passing a string path to `router` or `<NuxtLink/>`
-     * Ex:
+     * 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
      *
-     * ```ts
-     * router.push('/login'); // Error ❌
-     * ```
      * @default false
      */
     strict?: boolean | StrictOptions;
 }
 interface StrictOptions {
-    NuxtLink: StrictParamsOptions;
-    router: StrictParamsOptions;
+    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;

package/dist/module.json

@@ -5,5 +5,5 @@
     "nuxt": "^3.0.0-rc.1",
     "bridge": false
   },
-  "version": "2.2.2-beta.0"
+  "version": "2.2.2-beta.2"
 }

package/dist/module.mjs

@@ -209,6 +209,7 @@ function createTypedRouterFile() {
     RouteLocationNormalizedLoaded,
     RouteLocationRaw,
     Router,
+    RouteLocationPathRaw
   } from 'vue-router';
   import type {
     RoutesNamedLocations,
@@ -227,22 +228,26 @@ function createTypedRouterFile() {
    * {@link RouteLocationRaw}
    * */
   export type TypedRouteLocationRaw =
-  | (Omit<Exclude<RouteLocationRaw, string>, 'name' | 'params' ${returnIfTrue(
-      strictOptions.NuxtLink.strictRouteLocation,
-      `| 'path'`
-    )}> & RoutesNamedLocations)
-  ${returnIfFalse(strictOptions.NuxtLink.strictToArgument, "| string")};
+  | (Omit<Exclude<RouteLocationRaw, string>, 'name' | 'params'> & RoutesNamedLocations)
+  ${returnIfFalse(strictOptions.router.strictToArgument, "| string")}
+  ${returnIfTrue(
+      strictOptions.router.strictRouteLocation,
+      `| Omit<RouteLocationPathRaw, 'path'>`,
+      "| RouteLocationPathRaw"
+    )};
   
 
   /**
    * Alternative version of {@link TypedRouteLocationRaw} but with a name generic
    */
   export type TypedRouteLocationRawFromName<T extends RoutesNamesList> =
-  | (Omit<Exclude<RouteLocationRaw, string>, 'name' | 'params' ${returnIfTrue(
-      strictOptions.NuxtLink.strictRouteLocation,
-      `| 'path'`
-    )}> & TypedLocationAsRelativeRaw<T>)
-  ${returnIfFalse(strictOptions.NuxtLink.strictToArgument, "| string")};
+  | (Omit<Exclude<RouteLocationRaw, string>, 'name' | 'params'> & TypedLocationAsRelativeRaw<T>)
+  ${returnIfFalse(strictOptions.router.strictToArgument, "| string")}
+  ${returnIfTrue(
+      strictOptions.router.strictRouteLocation,
+      `| Omit<RouteLocationPathRaw, 'path'>`,
+      "| RouteLocationPathRaw"
+    )}
 
   /** 
    * Generic providing inference and dynamic inclusion of \`params\` property
@@ -352,7 +357,7 @@ function createTypedRouterDefinitionFile() {
     
     import type { NuxtLinkProps } from '#app';
     import type { DefineComponent } from 'vue';
-    import type { RouteLocationRaw } from 'vue-router';
+    import type { RouteLocationRaw, RouteLocationPathRaw } from 'vue-router';
     import type { RoutesNamedLocations, RoutesNamesListRecord } from './__routes';
     import type {TypedRouter, TypedRoute} from './__router';
     import { useRoute as _useRoute } from './__useTypedRoute';
@@ -372,13 +377,14 @@ function createTypedRouterDefinitionFile() {
     }
     
     type TypedNuxtLinkProps = Omit<NuxtLinkProps, 'to'> & {
-      to: ${returnIfFalse(
-      strictOptions.NuxtLink.strictToArgument,
-      "string |"
-    )} Omit<Exclude<RouteLocationRaw, string>, 'name' | 'params' ${returnIfTrue(
+      to: 
+      Omit<Exclude<RouteLocationRaw, string>, 'name' | 'params'> & RoutesNamedLocations
+      ${returnIfFalse(strictOptions.NuxtLink.strictToArgument, "| string")}
+      ${returnIfTrue(
       strictOptions.NuxtLink.strictRouteLocation,
-      `| 'path'`
-    )}> & RoutesNamedLocations;
+      `| Omit<RouteLocationPathRaw, 'path'>`,
+      "| RouteLocationPathRaw"
+    )}
     };
     
     export type TypedNuxtLink = DefineComponent<

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-typed-router",
-  "version": "2.2.2-beta.0",
+  "version": "2.2.2-beta.2",
   "description": "Provide autocompletion for pages route names generated by Nuxt router",
   "type": "module",
   "main": "./dist/module.cjs",
@@ -21,10 +21,10 @@
     "dev:build": "nuxi build playground",
     "dev:prepare": "nuxt-module-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 generate test/fixtures/complex",
+    "test:prepare-fixtures": "nuxi prepare test/fixtures/simple && nuxi prepare test/fixtures/withOptions && nuxi prepare test/fixtures/complex",
     "test:fixtures": " vitest run --dir test",
     "test:types": "pnpm run typecheck && pnpm run test:vue && vitest typecheck --run --dir test",
-    "test:vue": "vue-tsc -p test/fixtures/simple/tsconfig.json --noEmit && vue-tsc -p test/fixtures/complex/tsconfig.json --noEmit",
+    "test:vue": "vue-tsc -p test/fixtures/simple/tsconfig.json --noEmit && vue-tsc -p test/fixtures/complex/tsconfig.json --noEmit && vue-tsc -p test/fixtures/withOptions/tsconfig.json --noEmit",
     "test": "pnpm run dev:prepare && pnpm run test:fixtures && pnpm run test:types",
     "docs:dev": "cd docs && pnpm run dev",
     "docs:build": "npm run dev:prepare && cd docs && nuxi generate",
@@ -59,12 +59,12 @@
   "dependencies": {
     "@nuxt/kit": "3.1.1",
     "chalk": "^5.2.0",
+    "defu": "^6.1.2",
     "lodash-es": "^4.17.21",
     "log-symbols": "^5.1.0",
     "mkdirp": "^1.0.4",
     "pathe": "1.1.0",
-    "prettier": "2.8.3",
-    "defu": "^6.1.2"
+    "prettier": "2.8.3"
   },
   "devDependencies": {
     "@nuxt/module-builder": "^0.2.1",
@@ -77,6 +77,7 @@
     "@types/prettier": "^2.7.2",
     "@typescript-eslint/eslint-plugin": "^5.49.0",
     "@typescript-eslint/parser": "^5.49.0",
+    "@vue/test-utils": "^2.2.8",
     "cross-env": "^7.0.3",
     "eslint": "8.33.0",
     "eslint-config-prettier": "^8.6.0",