nuxt-typed-router 3.0.7 → 3.0.9

package/dist/module.d.ts

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

package/dist/module.json

@@ -5,5 +5,5 @@
     "nuxt": "^3.0.0",
     "bridge": false
   },
-  "version": "3.0.7"
+  "version": "3.0.9"
 }

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: true
   },
   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.7",
+  "version": "3.0.9",
   "description": "Provide autocompletion for routes paths, names and params in Nuxt apps",
   "type": "module",
   "main": "./dist/module.cjs",