@nuxt/kit 3.0.0-rc.9 → 3.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016-present - Nuxt Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,5 +1,128 @@
-# Nuxt Kit
 
-> Toolkit for authoring Nuxt Modules
+[![Nuxt banner](./.github/assets/banner.png)](https://nuxt.com)
+
+# 👋 Welcome to Nuxt
+
+
+Nuxt's goal is to make web development intuitive and performant, with a great developer experience.<br>Learn more in the ['What is Nuxt?'](https://nuxt.com/docs/getting-started/introduction) section of our documentation.
+
+
+ <p>
+  <a href="https://www.npmjs.com/package/nuxt"><img src="https://img.shields.io/npm/v/nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D" alt="Version"></a>
+  <a href="https://www.npmjs.com/package/nuxt"><img src="https://img.shields.io/npm/dm/nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D" alt="Downloads"></a>
+  <a href="./LICENSE"><img src="https://img.shields.io/github/license/nuxt/nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D" alt="License"></a>
+  <a href="https://volta.net/nuxt/nuxt?utm_source=nuxt_readme"><img src="https://user-images.githubusercontent.com/904724/209143798-32345f6c-3cf8-4e06-9659-f4ace4a6acde.svg" alt="Volta board"></a>
+ </p>
+
+<table>
+<thead>
+<tr>
+<th width="2000" colspan="2">
+</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+  <td width="80" align="center" valign="top">
+    <br>
+    <a href="https://nuxt.com/docs"><img src="./.github/assets/documentation.png"></a>
+  </td>
+  <td valign="top">
+    <h3>Documentation</h3>
+    <p>
+      We highly recommend you take a look at <a href="https://nuxt.com">the Nuxt documentation</a> to level up.
+    </p>
+  </td>
+</tr>
+<tr>
+  <td width="80" align="center" valign="top">
+    <br>
+    <a href="https://nuxt.com/modules"><img src="./.github/assets/modules.png"></a>
+  </td>
+  <td valign="top">
+    <h3>Modules</h3>
+    <p>
+      Discover our <a href="https://nuxt.com/modules">list of modules</a> to supercharge your Nuxt project. Created by the Nuxt team and community.
+    </p>
+  </td>
+</tr>
+<tr>
+  <td width="80" align="center" valign="top">
+    <br>
+    <a href="https://nuxt.com/docs/examples/hello-world"><img src="./.github/assets/examples.png"></a>
+  </td>
+  <td>
+    <h3>Examples</h3>
+    <p>
+      Explore different ways of using Nuxt features and get inspired with <a href="https://nuxt.com/docs/examples/essentials/hello-world">our list of examples</a>.
+    </p>
+  </td>
+</tr>
+</tbody>
+</table>
+
+<table>
+<thead>
+<tr>
+<th width="2000" colspan="2">
+</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+  <td width="80" align="center" valign="top">
+    <br>
+    <a href="https://nuxt.com/docs/community/reporting-bugs"><img src="./.github/assets/reporting-bugs.png"></a>
+  </td>
+  <td valign="top">
+    <h3>Reporting bugs</h3>
+    <p>
+      Check out the <a href="https://nuxt.com/docs/community/reporting-bugs">Reporting Bugs</a> page.</p>
+    </p>
+  </td>
+</tr>
+<tr>
+  <td width="80" align="center" valign="top">
+    <br>
+    <a href="https://nuxt.com/docs/community/contribution"><img src="./.github/assets/suggestions.png"></a>
+  </td>
+  <td valign="top">
+    <h3>Suggestions</h3>
+    <p>
+      Check out the <a href="https://nuxt.com/docs/community/contribution">Contribution</a> page.
+    </p>
+  </td>
+</tr>
+<tr>
+  <td width="80" align="center" valign="top">
+    <br>
+    <a href="https://nuxt.com/docs/community/getting-help"><img src="./.github/assets/questions.png"></a>
+  </td>
+  <td valign="top">
+    <h3>Questions</h3>
+    <p>
+      Check out the <a href="https://nuxt.com/docs/community/getting-help">Getting Help</a> page.
+    </p>
+  </td>
+</tr>
+</tbody>
+</table>
+
+## Local Development
+
+Follow the docs to [Set Up Your Local Development Environment](https://nuxt.com/docs/community/framework-contribution#set-up-your-local-development-environment) to contribute to the framework and documentation.
+
+## Nuxt 2
+
+You can find the code for Nuxt 2 on the [`2.x-dev` branch](https://github.com/nuxt/nuxt/tree/2.x-dev) and the documentation at [nuxtjs.org](https://nuxtjs.org).
+
+## Follow us
+
+<p valign="center">
+  <a href="https://chat.nuxt.dev"><img width="20px" src="./.github/assets/discord.svg" alt="Discord"></a>&nbsp;&nbsp;<a href="https://twitter.nuxt.dev"><img width="20px" src="./.github/assets/twitter.svg" alt="Twitter"></a>&nbsp;&nbsp;<a href="https://github.nuxt.dev"><img width="20px" src="./.github/assets/github.svg" alt="GitHub"></a>
+</p>
+
+## License
+
+[MIT](./LICENSE)
 
-Learn more about this package: <https://v3.nuxtjs.org>

package/dist/index.d.ts

@@ -1,16 +1,13 @@
-import { Nuxt, ModuleContainer, ModuleOptions, ModuleDefinition, NuxtModule, NuxtConfig, NuxtOptions, NuxtCompatibility, NuxtCompatibilityIssues, ComponentsDir, Component, NuxtTemplate, NuxtHooks, NuxtPlugin, NuxtPluginTemplate, ResolvedNuxtTemplate } from '@nuxt/schema';
+import { ModuleOptions, ModuleDefinition, NuxtModule, Nuxt, NuxtConfig, NuxtOptions, SchemaDefinition, ImportPresetWithDeprecation, NuxtCompatibility, NuxtCompatibilityIssues, ComponentsDir, Component, NuxtTemplate, NuxtHooks, NuxtPlugin, NuxtPluginTemplate, ResolvedNuxtTemplate } 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 unctx_index from 'unctx/index';
+import { NitroRouteConfig, NitroEventHandler, NitroDevEventHandler, Nitro } from 'nitropack';
 import * as consola from 'consola';
 import { genSafeVariableName } from 'knitwork';
 
-declare function useModuleContainer(nuxt?: Nuxt): ModuleContainer;
-
 /**
  * Define a Nuxt module, automatically merging defaults with user provided options, installing
  * any hooks that are provided, and calling an optional setup function for full control.
@@ -24,6 +21,8 @@ interface LoadNuxtConfigOptions extends LoadConfigOptions<NuxtConfig> {
 }
 declare function loadNuxtConfig(opts: LoadNuxtConfigOptions): Promise<NuxtOptions>;
 
+declare function extendNuxtSchema(def: SchemaDefinition | (() => SchemaDefinition)): void;
+
 interface LoadNuxtOptions extends LoadNuxtConfigOptions {
     /** Load nuxt with development mode */
     dev?: boolean;
@@ -38,15 +37,8 @@ declare function loadNuxt(opts: LoadNuxtOptions): Promise<Nuxt>;
 declare function buildNuxt(nuxt: Nuxt): Promise<any>;
 
 declare function addImports(imports: Import | Import[]): void;
-/**
- * @deprecated Please use `addImports` instead with nuxt>=3.0.0-rc.9
- */
-declare const addAutoImport: typeof addImports;
 declare function addImportsDir(dirs: string | string[]): void;
-/**
- * @deprecated Please use `addImportsDir` instead with nuxt>=3.0.0-rc.9
- */
-declare const addAutoImportDir: typeof addImportsDir;
+declare function addImportsSources(presets: ImportPresetWithDeprecation | ImportPresetWithDeprecation[]): void;
 
 interface ExtendConfigOptions {
     /**
@@ -75,18 +67,11 @@ interface ExtendConfigOptions {
     client?: boolean;
 }
 interface ExtendWebpackConfigOptions extends ExtendConfigOptions {
-    /**
-     * Install plugin on modern build
-     *
-     * @default true
-     * @deprecated Nuxt 2 only
-     */
-    modern?: boolean;
 }
 interface ExtendViteConfigOptions extends ExtendConfigOptions {
 }
 /**
- * Extend Webpack config
+ * Extend webpack config
  *
  * The fallback function might be called multiple times
  * when applying to both client and server builds.
@@ -97,13 +82,13 @@ declare function extendWebpackConfig(fn: ((config: Configuration) => void), opti
  */
 declare function extendViteConfig(fn: ((config: UserConfig) => void), options?: ExtendViteConfigOptions): (() => void) | undefined;
 /**
- * Append Webpack plugin to the config.
+ * Append webpack plugin to the config.
  */
-declare function addWebpackPlugin(plugin: WebpackPluginInstance, options?: ExtendWebpackConfigOptions): void;
+declare function addWebpackPlugin(plugin: WebpackPluginInstance | WebpackPluginInstance[], options?: ExtendWebpackConfigOptions): void;
 /**
  * Append Vite plugin to the config.
  */
-declare function addVitePlugin(plugin: Plugin, options?: ExtendViteConfigOptions): void;
+declare function addVitePlugin(plugin: Plugin | Plugin[], options?: ExtendViteConfigOptions): void;
 
 /**
  * Check version constraints and return incompatibility issues as an array
@@ -136,7 +121,7 @@ declare function getNuxtVersion(nuxt?: Nuxt | any): any;
  * Requires Nuxt 2.13+
  */
 declare function addComponentsDir(dir: ComponentsDir): Promise<void>;
-declare type AddComponentOptions = {
+type AddComponentOptions = {
     name: string;
     filePath: string;
 } & Partial<Exclude<Component, 'shortPath' | 'async' | 'level' | 'import' | 'asyncImport'>>;
@@ -148,7 +133,7 @@ declare type AddComponentOptions = {
 declare function addComponent(opts: AddComponentOptions): Promise<void>;
 
 /** Direct access to the Nuxt context - see https://github.com/unjs/unctx. */
-declare const nuxtCtx: unctx.UseContext<Nuxt>;
+declare const nuxtCtx: unctx_index.UseContext<Nuxt>;
 /**
  * Get access to Nuxt instance.
  *
@@ -183,6 +168,15 @@ declare function isIgnored(pathname: string): boolean;
 declare function addLayout(this: any, template: NuxtTemplate, name?: string): void;
 
 declare function extendPages(cb: NuxtHooks['pages:extend']): void;
+interface ExtendRouteRulesOptions {
+    /**
+     * Override route rule config
+     *
+     * @default false
+     */
+    override?: boolean;
+}
+declare function extendRouteRules(route: string, rule: NitroRouteConfig, options?: ExtendRouteRulesOptions): void;
 
 /**
  * Normalize a nuxt plugin object
@@ -247,18 +241,6 @@ declare function resolveFiles(path: string, pattern: string | string[], opts?: {
     followSymbolicLinks?: boolean;
 }): Promise<string[]>;
 
-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.
- *
- * @deprecated Use addServerHandler instead
- */
-declare function addServerMiddleware(middleware: LegacyServerMiddleware): void;
 /**
  * Adds a nitro server handler
  *
@@ -269,6 +251,30 @@ declare function addServerHandler(handler: NitroEventHandler): void;
  *
  */
 declare function addDevServerHandler(handler: NitroDevEventHandler): void;
+/**
+ * Adds a Nitro plugin
+ */
+declare function addServerPlugin(plugin: string): void;
+/**
+ * Adds routes to be prerendered
+ */
+declare function addPrerenderRoutes(routes: string | string[]): void;
+/**
+ * Access to the Nitro instance
+ *
+ * **Note:** You can call `useNitro()` only after `ready` hook.
+ *
+ * **Note:** Changes to the Nitro instance configuration are not applied.
+ *
+ * @example
+ *
+ * ```ts
+ * nuxt.hook('ready', () => {
+ *   console.log(useNitro())
+ * })
+ * ```
+ */
+declare function useNitro(): Nitro;
 
 /**
  * Renders given template using lodash template during build into the project buildDir
@@ -278,37 +284,53 @@ declare function addTemplate(_template: NuxtTemplate<any> | string): ResolvedNux
  * Normalize a nuxt template object
  */
 declare function normalizeTemplate(template: NuxtTemplate<any> | string): ResolvedNuxtTemplate<any>;
+/**
+ * Trigger rebuilding Nuxt templates
+ *
+ * You can pass a filter within the options to selectively regenerate a subset of templates.
+ */
+declare function updateTemplates(options?: {
+    filter?: (template: ResolvedNuxtTemplate<any>) => boolean;
+}): Promise<any>;
 
 declare const logger: consola.Consola;
 declare function useLogger(scope?: string): consola.Consola;
 
+/** @deprecated Do not use CJS utils */
 interface ResolveModuleOptions {
     paths?: string | string[];
 }
+/** @deprecated Do not use CJS utils */
 interface RequireModuleOptions extends ResolveModuleOptions {
     /** Clear the require cache (force fresh require) but only if not within `node_modules` */
     clearCache?: boolean;
     /** Automatically de-default the result of requiring the module. */
     interopDefault?: boolean;
 }
+/** @deprecated Do not use CJS utils */
 declare function isNodeModules(id: string): boolean;
+/** @deprecated Do not use CJS utils */
 declare function clearRequireCache(id: string): void;
+/** @deprecated Do not use CJS utils */
 declare function scanRequireTree(id: string, files?: Set<string>): Set<string>;
-/** Access the require cache by module id. */
+/** @deprecated Do not use CJS utils */
 declare function getRequireCacheItem(id: string): NodeModule | undefined;
 /** Resolve the `package.json` file for a given module. */
 declare function requireModulePkg(id: string, opts?: RequireModuleOptions): any;
-/** Resolve the path of a module. */
+/** @deprecated Do not use CJS utils */
 declare function resolveModule(id: string, opts?: ResolveModuleOptions): string;
-/** Try to resolve the path of a module, but don't emit an error if it can't be found. */
+/** @deprecated Do not use CJS utils */
 declare function tryResolveModule(path: string, opts?: ResolveModuleOptions): string | null;
-/** Require a module and return it. */
+/** @deprecated Do not use CJS utils */
 declare function requireModule(id: string, opts?: RequireModuleOptions): any;
+/** @deprecated Do not use CJS utils */
 declare function importModule(id: string, opts?: RequireModuleOptions): Promise<any>;
+/** @deprecated Do not use CJS utils */
 declare function tryImportModule(id: string, opts?: RequireModuleOptions): Promise<any> | undefined;
-/** Try to require a module, but don't emit an error if the module can't be required. */
+/** @deprecated Do not use CJS utils */
 declare function tryRequireModule(id: string, opts?: RequireModuleOptions): any;
 
+/** @deprecated */
 declare function compileTemplate(template: NuxtTemplate, ctx: any): Promise<string>;
 /** @deprecated */
 declare const templateUtils: {
@@ -319,4 +341,4 @@ declare const templateUtils: {
     }) => string;
 };
 
-export { AddComponentOptions, AddPluginOptions, ExtendConfigOptions, ExtendViteConfigOptions, ExtendWebpackConfigOptions, LegacyServerMiddleware, LoadNuxtConfigOptions, LoadNuxtOptions, RequireModuleOptions, ResolveModuleOptions, ResolvePathOptions, Resolver, addAutoImport, addAutoImportDir, addComponent, addComponentsDir, addDevServerHandler, addImports, addImportsDir, 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 };
+export { AddComponentOptions, AddPluginOptions, ExtendConfigOptions, ExtendRouteRulesOptions, ExtendViteConfigOptions, ExtendWebpackConfigOptions, LoadNuxtConfigOptions, LoadNuxtOptions, RequireModuleOptions, ResolveModuleOptions, ResolvePathOptions, Resolver, addComponent, addComponentsDir, addDevServerHandler, addImports, addImportsDir, addImportsSources, addLayout, addPlugin, addPluginTemplate, addPrerenderRoutes, addServerHandler, addServerPlugin, addTemplate, addVitePlugin, addWebpackPlugin, assertNuxtCompatibility, buildNuxt, checkNuxtCompatibility, clearRequireCache, compileTemplate, createResolver, defineNuxtModule, extendNuxtSchema, extendPages, extendRouteRules, 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, updateTemplates, useLogger, useNitro, useNuxt };