@nuxt/kit 3.0.0-rc.4 → 3.0.0-rc.7

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Nuxt, ModuleContainer, ModuleOptions, ModuleDefinition, NuxtModule, NuxtConfig, NuxtOptions, NuxtCompatibility, NuxtCompatibilityIssues, ComponentsDir, Component, NuxtHooks, NuxtPlugin, NuxtPluginTemplate, NuxtTemplate } from '@nuxt/schema';
+import { Nuxt, ModuleContainer, ModuleOptions, ModuleDefinition, NuxtModule, NuxtConfig, NuxtOptions, NuxtCompatibility, NuxtCompatibilityIssues, ComponentsDir, Component, NuxtTemplate, NuxtHooks, NuxtPlugin, NuxtPluginTemplate } from '@nuxt/schema';
 import { LoadConfigOptions } from 'c12';
 import { Import } from 'unimport';
 import { Configuration, WebpackPluginInstance } from 'webpack';
@@ -53,8 +53,6 @@ interface ExtendConfigOptions {
      * @default true
      */
     build?: boolean;
-}
-interface ExtendWebpackConfigOptions extends ExtendConfigOptions {
     /**
      * Install plugin on server side
      *
@@ -67,6 +65,8 @@ interface ExtendWebpackConfigOptions extends ExtendConfigOptions {
      * @default true
      */
     client?: boolean;
+}
+interface ExtendWebpackConfigOptions extends ExtendConfigOptions {
     /**
      * Install plugin on modern build
      *
@@ -87,7 +87,7 @@ declare function extendWebpackConfig(fn: ((config: Configuration) => void), opti
 /**
  * Extend Vite config
  */
-declare function extendViteConfig(fn: ((config: UserConfig) => void), options?: ExtendViteConfigOptions): void;
+declare function extendViteConfig(fn: ((config: UserConfig) => void), options?: ExtendViteConfigOptions): () => void;
 /**
  * Append Webpack plugin to the config.
  */
@@ -172,6 +172,8 @@ declare function tryUseNuxt(): Nuxt | null;
  */
 declare function isIgnored(pathname: string): boolean;
 
+declare function addLayout(tmpl: NuxtTemplate, name?: string): void;
+
 declare function extendPages(cb: NuxtHooks['pages:extend']): void;
 
 /**
@@ -233,7 +235,9 @@ interface Resolver {
  * Create a relative resolver
  */
 declare function createResolver(base: string | URL): Resolver;
-declare function resolveFiles(path: string, pattern: string | string[]): Promise<string[]>;
+declare function resolveFiles(path: string, pattern: string | string[], opts?: {
+    followSymbolicLinks?: boolean;
+}): Promise<string[]>;
 
 interface LegacyServerMiddleware {
     route?: string;
@@ -298,6 +302,7 @@ declare function tryImportModule(id: string, opts?: RequireModuleOptions): Promi
 declare function tryRequireModule(id: string, opts?: RequireModuleOptions): any;
 
 declare function compileTemplate(template: NuxtTemplate, ctx: any): Promise<string>;
+/** @deprecated */
 declare const templateUtils: {
     serialize: (data: any) => string;
     importName: typeof genSafeVariableName;
@@ -306,4 +311,4 @@ declare const templateUtils: {
     }) => string;
 };
 
-export { AddComponentOptions, AddPluginOptions, ExtendConfigOptions, ExtendViteConfigOptions, ExtendWebpackConfigOptions, LegacyServerMiddleware, LoadNuxtConfigOptions, LoadNuxtOptions, RequireModuleOptions, ResolveModuleOptions, ResolvePathOptions, Resolver, addAutoImport, addAutoImportDir, addComponent, addComponentsDir, addDevServerHandler, addPlugin, addPluginTemplate, addServerHandler, addServerMiddleware, addTemplate, addVitePlugin, addWebpackPlugin, assertNuxtCompatibility, buildNuxt, checkNuxtCompatibility, clearRequireCache, compileTemplate, createResolver, defineNuxtModule, extendPages, extendViteConfig, extendWebpackConfig, findPath, getNuxtVersion, getRequireCacheItem, hasNuxtCompatibility, importModule, installModule, isIgnored, isNodeModules, isNuxt2, isNuxt3, loadNuxt, loadNuxtConfig, logger, normalizePlugin, normalizeTemplate, nuxtCtx, requireModule, requireModulePkg, resolveAlias, resolveFiles, resolveModule, resolvePath, scanRequireTree, templateUtils, tryImportModule, tryRequireModule, tryResolveModule, tryUseNuxt, useLogger, useModuleContainer, useNuxt };
+export { AddComponentOptions, AddPluginOptions, ExtendConfigOptions, ExtendViteConfigOptions, ExtendWebpackConfigOptions, LegacyServerMiddleware, LoadNuxtConfigOptions, LoadNuxtOptions, RequireModuleOptions, ResolveModuleOptions, ResolvePathOptions, Resolver, addAutoImport, addAutoImportDir, addComponent, addComponentsDir, addDevServerHandler, addLayout, addPlugin, addPluginTemplate, addServerHandler, addServerMiddleware, addTemplate, addVitePlugin, addWebpackPlugin, assertNuxtCompatibility, buildNuxt, checkNuxtCompatibility, clearRequireCache, compileTemplate, createResolver, defineNuxtModule, extendPages, extendViteConfig, extendWebpackConfig, findPath, getNuxtVersion, getRequireCacheItem, hasNuxtCompatibility, importModule, installModule, isIgnored, isNodeModules, isNuxt2, isNuxt3, loadNuxt, loadNuxtConfig, logger, normalizePlugin, normalizeTemplate, nuxtCtx, requireModule, requireModulePkg, resolveAlias, resolveFiles, resolveModule, resolvePath, scanRequireTree, templateUtils, tryImportModule, tryRequireModule, tryResolveModule, tryUseNuxt, useLogger, useModuleContainer, useNuxt };

package/dist/index.mjs

@@ -1,13 +1,14 @@
-import { parse, basename, resolve, normalize, join, relative, isAbsolute, dirname } from 'pathe';
-import consola from 'consola';
+import { parse, basename, resolve, relative, join, normalize, isAbsolute, dirname } from 'pathe';
 import { existsSync, readFileSync, promises } from 'node:fs';
 import hash from 'hash-sum';
 import { getContext } from 'unctx';
+import { kebabCase, pascalCase } from 'scule';
 import satisfies from 'semver/functions/satisfies.js';
+import consola from 'consola';
 import { pathToFileURL, fileURLToPath } from 'node:url';
+import { globby } from 'globby';
 import { interopDefault } from 'mlly';
 import jiti from 'jiti';
-import { globby } from 'globby';
 import ignore from 'ignore';
 import defu from 'defu';
 import { applyDefaults } from 'untyped';
@@ -16,12 +17,6 @@ import { genSafeVariableName, genDynamicImport, genImport } from 'knitwork';
 import { loadConfig } from 'c12';
 import { NuxtConfigSchema } from '@nuxt/schema';
 import { resolvePackageJSON, readPackageJSON } from 'pkg-types';
-import { kebabCase, pascalCase } from 'scule';
-
-const logger = consola;
-function useLogger(scope) {
-  return scope ? logger.withScope(scope) : logger;
-}
 
 function chainFn(base, fn) {
   if (typeof fn !== "function") {
@@ -35,7 +30,11 @@ function chainFn(base, fn) {
     if (baseResult === void 0) {
       [baseResult] = args;
     }
-    const fnResult = fn.call(this, baseResult, ...Array.prototype.slice.call(args, 1));
+    const fnResult = fn.call(
+      this,
+      baseResult,
+      ...Array.prototype.slice.call(args, 1)
+    );
     if (fnResult === void 0) {
       return baseResult;
     }
@@ -45,14 +44,14 @@ function chainFn(base, fn) {
 
 const nuxtCtx = getContext("nuxt");
 function useNuxt() {
-  const instance = nuxtCtx.use();
+  const instance = nuxtCtx.tryUse();
   if (!instance) {
     throw new Error("Nuxt instance is unavailable!");
   }
   return instance;
 }
 function tryUseNuxt() {
-  return nuxtCtx.use();
+  return nuxtCtx.tryUse();
 }
 
 function addTemplate(_template) {
@@ -96,16 +95,6 @@ function normalizeTemplate(template) {
   return template;
 }
 
-function addServerMiddleware(middleware) {
-  useNuxt().options.serverMiddleware.push(middleware);
-}
-function addServerHandler(handler) {
-  useNuxt().options.serverHandlers.push(handler);
-}
-function addDevServerHandler(handler) {
-  useNuxt().options.devServerHandlers.push(handler);
-}
-
 async function checkNuxtCompatibility(constraints, nuxt = useNuxt()) {
   const issues = [];
   if (constraints.nuxt) {
@@ -162,38 +151,60 @@ function getNuxtVersion(nuxt = useNuxt()) {
   return version;
 }
 
-function normalizePlugin(plugin) {
-  if (typeof plugin === "string") {
-    plugin = { src: plugin };
-  } else {
-    plugin = { ...plugin };
-  }
-  if (!plugin.src) {
-    throw new Error("Invalid plugin. src option is required: " + JSON.stringify(plugin));
-  }
-  plugin.src = normalize(plugin.src);
-  if (plugin.ssr) {
-    plugin.mode = "server";
-  }
-  if (!plugin.mode) {
-    const [, mode = "all"] = plugin.src.match(/\.(server|client)(\.\w+)*$/) || [];
-    plugin.mode = mode;
-  }
-  return plugin;
+const logger = consola;
+function useLogger(scope) {
+  return scope ? logger.withScope(scope) : logger;
 }
-function addPlugin(_plugin, opts = {}) {
+
+function addLayout(tmpl, name) {
   const nuxt = useNuxt();
-  const plugin = normalizePlugin(_plugin);
-  nuxt.options.plugins = nuxt.options.plugins.filter((p) => normalizePlugin(p).src !== plugin.src);
-  nuxt.options.plugins[opts.append ? "push" : "unshift"](plugin);
-  return plugin;
+  const { filename, src } = addTemplate(tmpl);
+  const layoutName = kebabCase(name || parse(tmpl.filename).name).replace(/["']/g, "");
+  if (isNuxt2(nuxt)) {
+    const layout = nuxt.options.layouts[layoutName];
+    if (layout) {
+      return logger.warn(
+        `Not overriding \`${layoutName}\` (provided by \`${layout}\`) with \`${src || filename}\`.`
+      );
+    }
+    nuxt.options.layouts[layoutName] = `./${filename}`;
+    if (name === "error") {
+      this.addErrorLayout(filename);
+    }
+    return;
+  }
+  nuxt.hook("app:templates", (app) => {
+    if (layoutName in app.layouts) {
+      const relativePath = relative(nuxt.options.srcDir, app.layouts[layoutName].file);
+      return logger.warn(
+        `Not overriding \`${layoutName}\` (provided by \`~/${relativePath}\`) with \`${src || filename}\`.`
+      );
+    }
+    app.layouts[layoutName] = {
+      file: join("#build", filename),
+      name: layoutName
+    };
+  });
 }
-function addPluginTemplate(plugin, opts = {}) {
-  const normalizedPlugin = typeof plugin === "string" ? { src: plugin } : { ...plugin, src: addTemplate(plugin).dst };
-  return addPlugin(normalizedPlugin, opts);
+
+function normalizeHandlerMethod(handler) {
+  const [, method = void 0] = handler.handler.match(/\.(get|head|patch|post|put|delete|connect|options|trace)(\.\w+)*$/) || [];
+  return {
+    method,
+    ...handler
+  };
+}
+function addServerMiddleware(middleware) {
+  useNuxt().options.serverMiddleware.push(middleware);
+}
+function addServerHandler(handler) {
+  useNuxt().options.serverHandlers.push(normalizeHandlerMethod(handler));
+}
+function addDevServerHandler(handler) {
+  useNuxt().options.devServerHandlers.push(handler);
 }
 
-const _require = jiti(process.cwd(), { interopDefault: true });
+const _require = jiti(process.cwd(), { interopDefault: true, esmResolve: true });
 function isNodeModules(id) {
   return /[/\\]node_modules[/\\]/.test(id);
 }
@@ -240,7 +251,12 @@ function requireModulePkg(id, opts = {}) {
 }
 function resolveModule(id, opts = {}) {
   return normalize(_require.resolve(id, {
-    paths: [].concat(global.__NUXT_PREPATHS__, opts.paths, process.cwd(), global.__NUXT_PATHS__).filter(Boolean)
+    paths: [].concat(
+      global.__NUXT_PREPATHS__,
+      opts.paths,
+      process.cwd(),
+      global.__NUXT_PATHS__
+    ).filter(Boolean)
   }));
 }
 function tryResolveModule(path, opts = {}) {
@@ -304,7 +320,7 @@ function isIgnored(pathname) {
 async function resolvePath(path, opts = {}) {
   const _path = path;
   path = normalize(path);
-  if (isAbsolute(path) && existsSync(path)) {
+  if (isAbsolute(path) && existsSync(path) && !await isDirectory(path)) {
     return path;
   }
   const nuxt = useNuxt();
@@ -315,10 +331,10 @@ async function resolvePath(path, opts = {}) {
   if (!isAbsolute(path)) {
     path = resolve(cwd, path);
   }
-  let isDirectory = false;
+  let _isDir = false;
   if (existsSync(path)) {
-    isDirectory = (await promises.lstat(path)).isDirectory();
-    if (!isDirectory) {
+    _isDir = await isDirectory(path);
+    if (!_isDir) {
       return path;
     }
   }
@@ -328,7 +344,7 @@ async function resolvePath(path, opts = {}) {
       return pathWithExt;
     }
     const pathWithIndex = join(path, "index" + ext);
-    if (isDirectory && existsSync(pathWithIndex)) {
+    if (_isDir && existsSync(pathWithIndex)) {
       return pathWithIndex;
     }
   }
@@ -345,8 +361,8 @@ async function findPath(paths, opts, pathType = "file") {
   for (const path of paths) {
     const rPath = await resolvePath(path, opts);
     if (await existsSensitive(rPath)) {
-      const isDirectory = (await promises.lstat(rPath)).isDirectory();
-      if (!pathType || pathType === "file" && !isDirectory || pathType === "dir" && isDirectory) {
+      const _isDir = await isDirectory(rPath);
+      if (!pathType || pathType === "file" && !_isDir || pathType === "dir" && _isDir) {
         return rPath;
       }
     }
@@ -387,9 +403,43 @@ async function existsSensitive(path) {
   const dirFiles = await promises.readdir(dirname(path));
   return dirFiles.includes(basename(path));
 }
-async function resolveFiles(path, pattern) {
-  const files = await globby(pattern, { cwd: path, followSymbolicLinks: true });
-  return files.map((p) => resolve(path, p)).filter((p) => !isIgnored(p));
+async function isDirectory(path) {
+  return (await promises.lstat(path)).isDirectory();
+}
+async function resolveFiles(path, pattern, opts = {}) {
+  const files = await globby(pattern, { cwd: path, followSymbolicLinks: opts.followSymbolicLinks ?? true });
+  return files.map((p) => resolve(path, p)).filter((p) => !isIgnored(p)).sort();
+}
+
+function normalizePlugin(plugin) {
+  if (typeof plugin === "string") {
+    plugin = { src: plugin };
+  } else {
+    plugin = { ...plugin };
+  }
+  if (!plugin.src) {
+    throw new Error("Invalid plugin. src option is required: " + JSON.stringify(plugin));
+  }
+  plugin.src = normalize(resolveAlias(plugin.src));
+  if (plugin.ssr) {
+    plugin.mode = "server";
+  }
+  if (!plugin.mode) {
+    const [, mode = "all"] = plugin.src.match(/\.(server|client)(\.\w+)*$/) || [];
+    plugin.mode = mode;
+  }
+  return plugin;
+}
+function addPlugin(_plugin, opts = {}) {
+  const nuxt = useNuxt();
+  const plugin = normalizePlugin(_plugin);
+  nuxt.options.plugins = nuxt.options.plugins.filter((p) => normalizePlugin(p).src !== plugin.src);
+  nuxt.options.plugins[opts.append ? "push" : "unshift"](plugin);
+  return plugin;
+}
+function addPluginTemplate(plugin, opts = {}) {
+  const normalizedPlugin = typeof plugin === "string" ? { src: plugin } : { ...plugin, src: addTemplate(plugin).dst };
+  return addPlugin(normalizedPlugin, opts);
 }
 
 async function installModule(moduleToInstall, _inlineOptions, _nuxt) {
@@ -466,16 +516,7 @@ function useModuleContainer(nuxt = useNuxt()) {
       return addPluginTemplate(pluginTemplate);
     },
     addLayout(tmpl, name) {
-      const { filename, src } = addTemplate(tmpl);
-      const layoutName = name || parse(src).name;
-      const layout = nuxt.options.layouts[layoutName];
-      if (layout) {
-        logger.warn(`Duplicate layout registration, "${layoutName}" has been registered as "${layout}"`);
-      }
-      nuxt.options.layouts[layoutName] = `./${filename}`;
-      if (name === "error") {
-        this.addErrorLayout(filename);
-      }
+      return addLayout(tmpl, name);
     },
     addErrorLayout(dst) {
       const relativeBuildDir = relative(nuxt.options.rootDir, nuxt.options.buildDir);
@@ -531,7 +572,8 @@ const importSources = (sources, { lazy = false } = {}) => {
     return genImport(src, genSafeVariableName(src));
   }).join("\n");
 };
-const templateUtils = { serialize, importName: genSafeVariableName, importSources };
+const importName = genSafeVariableName;
+const templateUtils = { serialize, importName, importSources };
 
 function defineNuxtModule(definition) {
   if (typeof definition === "function") {
@@ -592,7 +634,7 @@ function nuxt2Shims(nuxt) {
   }
   nuxt[NUXT2_SHIMS_KEY] = true;
   nuxt.hooks = nuxt;
-  if (!nuxtCtx.use()) {
+  if (!nuxtCtx.tryUse()) {
     nuxtCtx.set(nuxt);
     nuxt.hook("close", () => nuxtCtx.unset());
   }
@@ -734,7 +776,17 @@ function extendViteConfig(fn, options = {}) {
   if (options.build === false && nuxt.options.build) {
     return;
   }
-  nuxt.hook("vite:extend", ({ config }) => fn(config));
+  if (options.server !== false && options.client !== false) {
+    return nuxt.hook("vite:extend", ({ config }) => fn(config));
+  }
+  nuxt.hook("vite:extendConfig", (config, { isClient, isServer }) => {
+    if (options.server !== false && isServer) {
+      return fn(config);
+    }
+    if (options.client !== false && isClient) {
+      return fn(config);
+    }
+  });
 }
 function addWebpackPlugin(plugin, options) {
   extendWebpackConfig((config) => {
@@ -778,7 +830,7 @@ async function addComponent(opts) {
     ...opts
   };
   nuxt.hook("components:extend", (components) => {
-    const existingComponent = components.find((c) => c.pascalName === component.pascalName || c.kebabName === component.kebabName);
+    const existingComponent = components.find((c) => (c.pascalName === component.pascalName || c.kebabName === component.kebabName) && c.mode === component.mode);
     if (existingComponent) {
       const name = existingComponent.pascalName || existingComponent.kebabName;
       console.warn(`Overriding ${name} component.`);
@@ -798,4 +850,4 @@ function extendPages(cb) {
   }
 }
 
-export { addAutoImport, addAutoImportDir, addComponent, addComponentsDir, addDevServerHandler, addPlugin, addPluginTemplate, addServerHandler, addServerMiddleware, addTemplate, addVitePlugin, addWebpackPlugin, assertNuxtCompatibility, buildNuxt, checkNuxtCompatibility, clearRequireCache, compileTemplate, createResolver, defineNuxtModule, extendPages, extendViteConfig, extendWebpackConfig, findPath, getNuxtVersion, getRequireCacheItem, hasNuxtCompatibility, importModule, installModule, isIgnored, isNodeModules, isNuxt2, isNuxt3, loadNuxt, loadNuxtConfig, logger, normalizePlugin, normalizeTemplate, nuxtCtx, requireModule, requireModulePkg, resolveAlias, resolveFiles, resolveModule, resolvePath, scanRequireTree, templateUtils, tryImportModule, tryRequireModule, tryResolveModule, tryUseNuxt, useLogger, useModuleContainer, useNuxt };
+export { addAutoImport, addAutoImportDir, addComponent, addComponentsDir, addDevServerHandler, addLayout, addPlugin, addPluginTemplate, addServerHandler, addServerMiddleware, addTemplate, addVitePlugin, addWebpackPlugin, assertNuxtCompatibility, buildNuxt, checkNuxtCompatibility, clearRequireCache, compileTemplate, createResolver, defineNuxtModule, extendPages, extendViteConfig, extendWebpackConfig, findPath, getNuxtVersion, getRequireCacheItem, hasNuxtCompatibility, importModule, installModule, isIgnored, isNodeModules, isNuxt2, isNuxt3, loadNuxt, loadNuxtConfig, logger, normalizePlugin, normalizeTemplate, nuxtCtx, requireModule, requireModulePkg, resolveAlias, resolveFiles, resolveModule, resolvePath, scanRequireTree, templateUtils, tryImportModule, tryRequireModule, tryResolveModule, tryUseNuxt, useLogger, useModuleContainer, useNuxt };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuxt/kit",
-  "version": "3.0.0-rc.4",
+  "version": "3.0.0-rc.7",
   "repository": "nuxt/framework",
   "license": "MIT",
   "type": "module",
@@ -13,24 +13,24 @@
     "prepack": "unbuild"
   },
   "dependencies": {
-    "@nuxt/schema": "^3.0.0-rc.4",
-    "c12": "^0.2.7",
+    "@nuxt/schema": "3.0.0-rc.7",
+    "c12": "^0.2.9",
     "consola": "^2.15.3",
     "defu": "^6.0.0",
     "globby": "^13.1.2",
     "hash-sum": "^2.0.0",
     "ignore": "^5.2.0",
-    "jiti": "^1.13.0",
+    "jiti": "^1.14.0",
     "knitwork": "^0.1.2",
     "lodash.template": "^4.5.0",
-    "mlly": "^0.5.2",
-    "pathe": "^0.3.0",
-    "pkg-types": "^0.3.2",
-    "scule": "^0.2.1",
+    "mlly": "^0.5.10",
+    "pathe": "^0.3.4",
+    "pkg-types": "^0.3.3",
+    "scule": "^0.3.2",
     "semver": "^7.3.7",
-    "unctx": "^1.1.4",
-    "unimport": "^0.2.7",
-    "untyped": "^0.4.4"
+    "unctx": "^2.0.1",
+    "unimport": "^0.6.7",
+    "untyped": "^0.4.5"
   },
   "devDependencies": {
     "@types/lodash.template": "^4",