nuxt-typed-router 3.0.6 → 3.0.8

package/dist/module.d.ts

@@ -24,6 +24,11 @@ interface ModuleOptions {
      * @default false
      */
     strict?: boolean | StrictOptions;
+    /**
+     * Remove Nuxt definitions to avoid conflicts
+     * @default false
+     */
+    experimentalRemoveNuxtDefs?: boolean;
 }
 interface StrictOptions {
     NuxtLink?: StrictParamsOptions;

package/dist/module.json

@@ -5,5 +5,5 @@
     "nuxt": "^3.0.0",
     "bridge": false
   },
-  "version": "3.0.6"
+  "version": "3.0.8"
 }

package/dist/module.mjs

@@ -1,4 +1,4 @@
-import { addPluginTemplate, extendPages, defineNuxtModule, createResolver } from '@nuxt/kit';
+import { addPluginTemplate, extendPages, createResolver, defineNuxtModule } from '@nuxt/kit';
 import chalk from 'chalk';
 import logSymbols from 'log-symbols';
 import { defu } from 'defu';
@@ -10,6 +10,7 @@ import { fileURLToPath } from 'url';
 import { dirname, resolve } from 'pathe';
 import mkdirp from 'mkdirp';
 import { camelCase } from 'lodash-es';
+import { readFile } from 'fs/promises';
 
 class ModuleOptionsStore {
   constructor() {
@@ -18,6 +19,7 @@ class ModuleOptionsStore {
     this.experimentalPathCheck = true;
     this.autoImport = false;
     this.rootDir = "";
+    this.buildDir = "";
     this.i18n = false;
     this.i18nOptions = null;
     this.i18nLocales = [];
@@ -31,6 +33,8 @@ class ModuleOptionsStore {
       this.autoImport = options.autoImport;
     if (options.rootDir != null)
       this.rootDir = options.rootDir;
+    if (options.buildDir != null)
+      this.buildDir = options.buildDir;
     if (options.i18n != null)
       this.i18n = options.i18n;
     if (options.i18nOptions != null) {
@@ -1613,6 +1617,46 @@ async function createTypedRouter({
   }
 }
 
+async function removeNuxtDefinitions({
+  buildDir,
+  autoImport
+}) {
+  const { resolve } = createResolver(import.meta.url);
+  const componentDefinitions = await readFile(resolve(buildDir, "components.d.ts"), {
+    encoding: "utf8"
+  });
+  const replacedNuxtLink = componentDefinitions.replace(
+    /'NuxtLink': typeof import\(".*"\)\['default'\]/gm,
+    ""
+  );
+  processPathAndWriteFile({
+    content: replacedNuxtLink,
+    fileName: "components.d.ts",
+    outDir: ".nuxt"
+  });
+  if (autoImport) {
+    let globalDefinitions = await readFile(resolve(buildDir, "types/imports.d.ts"), {
+      encoding: "utf8"
+    });
+    const importsToRemove = [
+      "useRouter",
+      "useRoute",
+      "useLocalePath",
+      "useLocaleRoute",
+      "definePageMeta",
+      "navigateTo"
+    ].map((m) => new RegExp(`const ${m}: typeof import\\('.*'\\)\\['${m}'\\]`, "gm"));
+    importsToRemove.forEach((imp) => {
+      globalDefinitions = globalDefinitions.replace(imp, "");
+    });
+    processPathAndWriteFile({
+      content: globalDefinitions,
+      fileName: "types/imports.d.ts",
+      outDir: ".nuxt"
+    });
+  }
+}
+
 const module = defineNuxtModule({
   meta: {
     name: "nuxt-typed-router",
@@ -1622,7 +1666,8 @@ const module = defineNuxtModule({
   defaults: {
     plugin: false,
     strict: false,
-    experimentalPathCheck: true
+    experimentalPathCheck: true,
+    experimentalRemoveNuxtDefs: false
   },
   setup(moduleOptions, nuxt) {
     const { resolve } = createResolver(import.meta.url);
@@ -1661,6 +1706,12 @@ const module = defineNuxtModule({
           experimentalRfc436: true
         };
       }
+      if (moduleOptions.experimentalRemoveNuxtDefs) {
+        removeNuxtDefinitions({
+          autoImport: nuxt.options.imports.autoImport ?? true,
+          buildDir: nuxt.options.buildDir
+        });
+      }
     });
     if (nuxt.options.dev) {
       nuxt.hook("devtools:customTabs", (tabs) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-typed-router",
-  "version": "3.0.6",
+  "version": "3.0.8",
   "description": "Provide autocompletion for routes paths, names and params in Nuxt apps",
   "type": "module",
   "main": "./dist/module.cjs",
@@ -12,8 +12,7 @@
     }
   },
   "files": [
-    "dist",
-    "main.d.ts"
+    "dist"
   ],
   "scripts": {
     "prepack": "nuxt-module-build",
@@ -60,7 +59,7 @@
     "url": "https://github.com/victorgarciaesgi/nuxt-typed-router/issues"
   },
   "dependencies": {
-    "@nuxt/kit": "^3.2.2",
+    "@nuxt/kit": "^3.3.1",
     "chalk": "^5.2.0",
     "defu": "^6.1.2",
     "lodash-es": "^4.17.21",
@@ -68,36 +67,36 @@
     "mkdirp": "^2.1.5",
     "nanoid": "^4.0.1",
     "pathe": "1.1.0",
-    "prettier": "2.8.4"
+    "prettier": "2.8.6"
   },
   "devDependencies": {
     "@nuxt/devtools": "^0.2.5",
     "@nuxt/module-builder": "^0.2.1",
-    "@nuxt/test-utils": "^3.2.2",
-    "@nuxt/types": "^2.16.0",
+    "@nuxt/test-utils": "^3.3.1",
+    "@nuxt/types": "^2.16.3",
     "@nuxtjs/eslint-config-typescript": "^12.0.0",
     "@nuxtjs/i18n": "8.0.0-beta.9",
-    "@nuxtjs/web-vitals": "^0.2.2",
-    "@types/lodash-es": "^4.17.6",
-    "@types/node": "^18.14.6",
+    "@nuxtjs/web-vitals": "^0.2.4",
+    "@types/lodash-es": "^4.17.7",
+    "@types/node": "^18.15.5",
     "@types/prettier": "^2.7.2",
-    "@typescript-eslint/eslint-plugin": "^5.54.1",
-    "@typescript-eslint/parser": "^5.54.1",
-    "@vue/test-utils": "^2.3.0",
+    "@typescript-eslint/eslint-plugin": "^5.56.0",
+    "@typescript-eslint/parser": "^5.56.0",
+    "@vue/test-utils": "^2.3.2",
     "bumpp": "9.0.0",
     "changelogithub": "0.12.7",
     "cross-env": "^7.0.3",
-    "eslint": "8.35.0",
-    "eslint-config-prettier": "^8.7.0",
+    "eslint": "8.36.0",
+    "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-vue": "^9.9.0",
-    "nuxt": "3.2.3",
+    "nuxt": "3.3.1",
+    "nuxt-seo-kit": "1.3.5",
     "playwright": "1.31.2",
-    "tsd": "^0.26.0",
-    "typescript": "^4.9.5",
-    "vitest": "^0.29.2",
+    "tsd": "^0.28.0",
+    "typescript": "^5.0.2",
+    "vitest": "^0.29.7",
     "vue-eslint-parser": "^9.1.0",
     "vue-router": "^4.1.6",
-    "vue-tsc": "^1.1.7",
-    "nuxt-seo-kit": "1.3.4"
+    "vue-tsc": "^1.1.7"
   }
 }