nuxt-typed-router 3.3.0 → 3.3.2

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.0"
+  "version": "3.3.2"
 }

package/dist/module.mjs

@@ -12,20 +12,26 @@ import { mkdirp } from 'mkdirp';
 import { camelCase } from 'lodash-es';
 import { readFile } from 'fs/promises';
 
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
 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 = [];
+    __publicField(this, "plugin", false);
+    __publicField(this, "strict", false);
+    __publicField(this, "pathCheck", true);
+    __publicField(this, "autoImport", false);
+    __publicField(this, "rootDir", "");
+    __publicField(this, "buildDir", "");
+    __publicField(this, "srcDir", "");
+    __publicField(this, "pagesDir", "");
+    __publicField(this, "i18n", false);
+    __publicField(this, "i18nOptions", null);
+    __publicField(this, "i18nLocales", []);
+    __publicField(this, "experimentalIgnoreRoutes", []);
   }
   updateOptions(options) {
     if (options.plugin != null)
@@ -1690,6 +1696,14 @@ const module = defineNuxtModule({
         });
       }
     });
+    nuxt.hook("build:done", () => {
+      if (moduleOptions.experimentalRemoveNuxtDefs) {
+        removeNuxtDefinitions({
+          autoImport: nuxt.options.imports.autoImport ?? true,
+          buildDir: nuxt.options.buildDir
+        });
+      }
+    });
     if (nuxt.options.dev) {
       nuxt.hook("devtools:customTabs", (tabs) => {
         tabs.push({

package/dist/types.d.mts

@@ -0,0 +1,15 @@
+
+import { 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 { ModuleOptions, default } from './module'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-typed-router",
-  "version": "3.3.0",
+  "version": "3.3.2",
   "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",
+    "@nuxt/kit": "^3.8.0",
     "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",
+    "nanoid": "^5.0.2",
     "pathe": "1.1.1"
   },
   "devDependencies": {
-    "@nuxt/devtools": "^0.8.0",
-    "@nuxt/module-builder": "^0.4.0",
-    "@nuxt/test-utils": "^3.6.5",
+    "@nuxt/devtools": "^1.0.0",
+    "@nuxt/module-builder": "^0.5.2",
+    "@nuxt/test-utils": "^3.8.0",
     "@nuxt/types": "^2.17.1",
-    "@nuxtjs/eslint-config-typescript": "^12.0.0",
+    "@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/lodash-es": "^4.17.10",
+    "@types/node": "^20.8.7",
     "@types/prettier": "^3.0.0",
-    "@typescript-eslint/eslint-plugin": "^6.4.0",
-    "@typescript-eslint/parser": "^6.4.0",
+    "@typescript-eslint/eslint-plugin": "^6.8.0",
+    "@typescript-eslint/parser": "^6.8.0",
     "@vue/test-utils": "^2.4.1",
-    "bumpp": "9.1.1",
-    "changelogithub": "0.12.12",
+    "bumpp": "9.2.0",
+    "changelogithub": "0.13.1",
     "cross-env": "^7.0.3",
-    "eslint": "8.47.0",
+    "eslint": "8.51.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-vue": "^9.17.0",
-    "nuxt": "3.6.5",
-    "nuxt-seo-kit": "1.3.9",
-    "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"
+    "nuxt": "3.8.0",
+    "nuxt-seo-kit": "1.3.13",
+    "playwright": "1.39.0",
+    "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.19"
   }
 }