@nuxt/kit 3.0.0-rc.2 → 3.0.0-rc.5

package/dist/index.d.ts

@@ -1,11 +1,13 @@
-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';
 import { UserConfig, Plugin } from 'vite';
 import * as unctx from 'unctx';
 import { Middleware } from 'h3';
+import { NitroEventHandler, NitroDevEventHandler } from 'nitropack';
 import * as consola from 'consola';
+import { genSafeVariableName } from 'knitwork';
 
 declare function useModuleContainer(nuxt?: Nuxt): ModuleContainer;
 
@@ -51,8 +53,6 @@ interface ExtendConfigOptions {
      * @default true
      */
     build?: boolean;
-}
-interface ExtendWebpackConfigOptions extends ExtendConfigOptions {
     /**
      * Install plugin on server side
      *
@@ -65,6 +65,8 @@ interface ExtendWebpackConfigOptions extends ExtendConfigOptions {
      * @default true
      */
     client?: boolean;
+}
+interface ExtendWebpackConfigOptions extends ExtendConfigOptions {
     /**
      * Install plugin on modern build
      *
@@ -170,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,12 +237,28 @@ interface Resolver {
 declare function createResolver(base: string | URL): Resolver;
 declare function resolveFiles(path: string, pattern: string | string[]): Promise<string[]>;
 
-interface ServerMiddleware {
+interface LegacyServerMiddleware {
     route?: string;
+    path?: string;
+    handle?: Middleware | string;
     handler: Middleware | string;
 }
-/** Adds a new server middleware to the end of the server middleware array. */
-declare function addServerMiddleware(middleware: ServerMiddleware): void;
+/**
+ * Adds a new server middleware to the end of the server middleware array.
+ *
+ * @deprecated Use addServerHandler instead
+ */
+declare function addServerMiddleware(middleware: LegacyServerMiddleware): void;
+/**
+ * Adds a nitro server handler
+ *
+ */
+declare function addServerHandler(handler: NitroEventHandler): void;
+/**
+ * Adds a nitro server handler for development-only
+ *
+ */
+declare function addDevServerHandler(handler: NitroDevEventHandler): void;
 
 /**
  * Renders given template using lodash template during build into the project buildDir
@@ -282,10 +302,10 @@ declare function tryRequireModule(id: string, opts?: RequireModuleOptions): any;
 declare function compileTemplate(template: NuxtTemplate, ctx: any): Promise<string>;
 declare const templateUtils: {
     serialize: (data: any) => string;
-    importName: (src: string) => string;
+    importName: typeof genSafeVariableName;
     importSources: (sources: string | string[], { lazy }?: {
         lazy?: boolean;
     }) => string;
 };
 
-export { AddComponentOptions, AddPluginOptions, ExtendConfigOptions, ExtendViteConfigOptions, ExtendWebpackConfigOptions, LoadNuxtConfigOptions, LoadNuxtOptions, RequireModuleOptions, ResolveModuleOptions, ResolvePathOptions, Resolver, ServerMiddleware, addAutoImport, addAutoImportDir, addComponent, addComponentsDir, addPlugin, addPluginTemplate, 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,9 +1,10 @@
-import { parse, basename, resolve, normalize, join, relative, isAbsolute, dirname, extname } 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 { interopDefault } from 'mlly';
 import jiti from 'jiti';
@@ -12,17 +13,11 @@ import ignore from 'ignore';
 import defu from 'defu';
 import { applyDefaults } from 'untyped';
 import lodashTemplate from 'lodash.template';
-import { camelCase, kebabCase, pascalCase } from 'scule';
-import { genDynamicImport, genImport } from 'knitwork';
+import { genSafeVariableName, genDynamicImport, genImport } from 'knitwork';
 import { loadConfig } from 'c12';
 import { NuxtConfigSchema } from '@nuxt/schema';
 import { resolvePackageJSON, readPackageJSON } from 'pkg-types';
 
-const logger = consola;
-function useLogger(scope) {
-  return scope ? logger.withScope(scope) : logger;
-}
-
 function chainFn(base, fn) {
   if (typeof fn !== "function") {
     return base;
@@ -96,10 +91,6 @@ function normalizeTemplate(template) {
   return template;
 }
 
-function addServerMiddleware(middleware) {
-  useNuxt().options.serverMiddleware.push(middleware);
-}
-
 async function checkNuxtCompatibility(constraints, nuxt = useNuxt()) {
   const issues = [];
   if (constraints.nuxt) {
@@ -113,7 +104,7 @@ async function checkNuxtCompatibility(constraints, nuxt = useNuxt()) {
     }
   }
   if (isNuxt2(nuxt)) {
-    const bridgeRequirement = constraints?.bridge;
+    const bridgeRequirement = constraints.bridge;
     const hasBridge = !!nuxt.options.bridge;
     if (bridgeRequirement === true && !hasBridge) {
       issues.push({
@@ -151,11 +142,60 @@ function isNuxt3(nuxt = useNuxt()) {
 function getNuxtVersion(nuxt = useNuxt()) {
   const version = (nuxt?._version || nuxt?.version || nuxt?.constructor?.version || "").replace(/^v/g, "");
   if (!version) {
-    throw new Error("Cannot determine nuxt version! Is currect instance passed?");
+    throw new Error("Cannot determine nuxt version! Is current instance passed?");
   }
   return version;
 }
 
+const logger = consola;
+function useLogger(scope) {
+  return scope ? logger.withScope(scope) : logger;
+}
+
+function addLayout(tmpl, name) {
+  const nuxt = useNuxt();
+  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 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);
+}
+
 function normalizePlugin(plugin) {
   if (typeof plugin === "string") {
     plugin = { src: plugin };
@@ -383,7 +423,7 @@ async function existsSensitive(path) {
 }
 async function resolveFiles(path, pattern) {
   const files = await globby(pattern, { cwd: path, followSymbolicLinks: true });
-  return files.filter((p) => !isIgnored(p)).map((p) => resolve(path, p));
+  return files.map((p) => resolve(path, p)).filter((p) => !isIgnored(p));
 }
 
 async function installModule(moduleToInstall, _inlineOptions, _nuxt) {
@@ -460,16 +500,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);
@@ -514,19 +545,18 @@ async function compileTemplate(template, ctx) {
   throw new Error("Invalid template: " + JSON.stringify(template));
 }
 const serialize = (data) => JSON.stringify(data, null, 2).replace(/"{(.+)}"(?=,?$)/gm, (r) => JSON.parse(r).replace(/^{(.*)}$/, "$1"));
-const importName = (src) => `${camelCase(basename(src, extname(src))).replace(/[^a-zA-Z?\d\s:]/g, "")}_${hash(src)}`;
 const importSources = (sources, { lazy = false } = {}) => {
   if (!Array.isArray(sources)) {
     sources = [sources];
   }
   return sources.map((src) => {
     if (lazy) {
-      return `const ${importName(src)} = ${genDynamicImport(src, { comment: `webpackChunkName: ${JSON.stringify(src)}` })}`;
+      return `const ${genSafeVariableName(src)} = ${genDynamicImport(src, { comment: `webpackChunkName: ${JSON.stringify(src)}` })}`;
     }
-    return genImport(src, importName(src));
+    return genImport(src, genSafeVariableName(src));
   }).join("\n");
 };
-const templateUtils = { serialize, importName, importSources };
+const templateUtils = { serialize, importName: genSafeVariableName, importSources };
 
 function defineNuxtModule(definition) {
   if (typeof definition === "function") {
@@ -538,7 +568,7 @@ function defineNuxtModule(definition) {
   }
   if (!definition.meta.configKey) {
     definition.meta.name = definition.meta.name || definition.name;
-    definition.meta.configKey = definition.meta.configKey || definition.configKey || definition.meta.name;
+    definition.meta.configKey = definition.configKey || definition.meta.name;
   }
   function getOptions(inlineOptions, nuxt = useNuxt()) {
     const configKey = definition.meta.configKey || definition.meta.name;
@@ -729,7 +759,14 @@ function extendViteConfig(fn, options = {}) {
   if (options.build === false && nuxt.options.build) {
     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) => {
@@ -773,7 +810,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.`);
@@ -793,4 +830,4 @@ function extendPages(cb) {
   }
 }
 
-export { addAutoImport, addAutoImportDir, addComponent, addComponentsDir, addPlugin, addPluginTemplate, 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.2",
+  "version": "3.0.0-rc.5",
   "repository": "nuxt/framework",
   "license": "MIT",
   "type": "module",
@@ -13,23 +13,23 @@
     "prepack": "unbuild"
   },
   "dependencies": {
-    "@nuxt/schema": "^3.0.0-rc.2",
-    "c12": "^0.2.7",
+    "@nuxt/schema": "^3.0.0-rc.5",
+    "c12": "^0.2.8",
     "consola": "^2.15.3",
     "defu": "^6.0.0",
-    "globby": "^13.1.1",
+    "globby": "^13.1.2",
     "hash-sum": "^2.0.0",
     "ignore": "^5.2.0",
-    "jiti": "^1.13.0",
-    "knitwork": "^0.1.1",
+    "jiti": "^1.14.0",
+    "knitwork": "^0.1.2",
     "lodash.template": "^4.5.0",
-    "mlly": "^0.5.2",
-    "pathe": "^0.2.0",
-    "pkg-types": "^0.3.2",
+    "mlly": "^0.5.4",
+    "pathe": "^0.3.2",
+    "pkg-types": "^0.3.3",
     "scule": "^0.2.1",
     "semver": "^7.3.7",
     "unctx": "^1.1.4",
-    "unimport": "^0.1.8",
+    "unimport": "^0.4.4",
     "untyped": "^0.4.4"
   },
   "devDependencies": {