@nuxt/nitro-server 3.20.2 → 3.21.0

package/README.md

@@ -6,9 +6,11 @@
   <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="https://github.com/nuxt/nuxt/blob/main/LICENSE"><img src="https://img.shields.io/github/license/nuxt/nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D" alt="License"></a>
+  <a href="https://nuxt.com/modules"><img src="https://img.shields.io/badge/dynamic/json?url=https://nuxt.com/api/v1/modules&query=$.stats.modules&label=Modules&style=flat&colorA=18181B&colorB=28CF8D" alt="Modules"></a>
   <a href="https://nuxt.com"><img src="https://img.shields.io/badge/Nuxt%20Docs-18181B?logo=nuxt" alt="Website"></a>
   <a href="https://chat.nuxt.dev"><img src="https://img.shields.io/badge/Nuxt%20Discord-18181B?logo=discord" alt="Discord"></a>
   <a href="https://securityscorecards.dev/"><img src="https://api.securityscorecards.dev/projects/github.com/nuxt/nuxt/badge" alt="Nuxt openssf scorecard score"></a>
+  <a href="https://deepwiki.com/nuxt/nuxt"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
 </p>
 
 Nuxt is a free and open-source framework with an intuitive and extendable way to create type-safe, performant and production-grade full-stack web applications and websites with Vue.js.
@@ -21,14 +23,14 @@ It provides a number of features that make it easy to build fast, SEO-friendly,
 - Auto imports of components, composables and utils
 - TypeScript with zero configuration
 - Go full-stack with our server/ directory
-- Extensible with [200+ modules](https://nuxt.com/modules)
+- Extensible with [300+ modules](https://nuxt.com/modules)
 - Deployment to a variety of [hosting platforms](https://nuxt.com/deploy)
 - ...[and much more](https://nuxt.com) 🚀
 
 ### Table of Contents
 
 - 🚀 [Getting Started](#getting-started)
-- 💻 [ Vue Development](#vue-development)
+- 💻 [Vue Development](#vue-development)
 - 📖 [Documentation](#documentation)
 - 🧩 [Modules](#modules)
 - ❤️ [Contribute](#contribute)

package/dist/index.d.mts

@@ -1,47 +1,283 @@
-import { Nuxt } from '@nuxt/schema';
-import { Nitro } from 'nitropack/types';
-import { H3Event } from 'h3';
-import { LogObject } from 'consola';
-import { NuxtRenderHTMLContext, NuxtIslandResponse, NuxtIslandContext } from 'nuxt/app';
-import { RuntimeConfig } from 'nuxt/schema';
+import { EventHandler, H3Event } from "h3";
+import { Nuxt } from "@nuxt/schema";
+import { Nitro, NitroConfig, NitroDevEventHandler, NitroEventHandler, NitroOptions, NitroRouteConfig, NitroRuntimeConfig, NitroRuntimeConfigApp } from "nitropack/types";
+import { LogObject } from "consola";
+import { NuxtIslandContext, NuxtIslandResponse, NuxtRenderHTMLContext } from "nuxt/app";
+import { HookResult, RuntimeConfig, TSReference } from "nuxt/schema";
 
-declare module 'nitropack' {
-    interface NitroRuntimeConfigApp {
-        buildAssetsDir: string;
-        cdnURL: string;
-    }
-    interface NitroRuntimeConfig extends RuntimeConfig {
-    }
-    interface NitroRouteConfig {
-        ssr?: boolean;
-        noScripts?: boolean;
-        /** @deprecated Use `noScripts` instead */
-        experimentalNoScripts?: boolean;
-    }
-    interface NitroRouteRules {
-        ssr?: boolean;
-        noScripts?: boolean;
-        /** @deprecated Use `noScripts` instead */
-        experimentalNoScripts?: boolean;
-        appMiddleware?: Record<string, boolean>;
-    }
-    interface NitroRuntimeHooks {
-        'dev:ssr-logs': (ctx: {
-            logs: LogObject[];
-            path: string;
-        }) => void | Promise<void>;
-        'render:html': (htmlContext: NuxtRenderHTMLContext, context: {
-            event: H3Event;
-        }) => void | Promise<void>;
-        'render:island': (islandResponse: NuxtIslandResponse, context: {
-            event: H3Event;
-            islandContext: NuxtIslandContext;
-        }) => void | Promise<void>;
-    }
+//#region src/augments.d.ts
+declare module "nitropack" {
+  interface NitroRuntimeConfigApp {
+    buildAssetsDir: string;
+    cdnURL: string;
+  }
+  interface NitroRuntimeConfig extends RuntimeConfig {}
+  interface NitroRouteConfig {
+    ssr?: boolean;
+    noScripts?: boolean;
+    /** @deprecated Use `noScripts` instead */
+    experimentalNoScripts?: boolean;
+  }
+  interface NitroRouteRules {
+    ssr?: boolean;
+    noScripts?: boolean;
+    /** @deprecated Use `noScripts` instead */
+    experimentalNoScripts?: boolean;
+    appMiddleware?: Record<string, boolean>;
+    appLayout?: string | false;
+  }
+  interface NitroRuntimeHooks {
+    "dev:ssr-logs": (ctx: {
+      logs: LogObject[];
+      path: string;
+    }) => void | Promise<void>;
+    "render:html": (htmlContext: NuxtRenderHTMLContext, context: {
+      event: H3Event;
+    }) => void | Promise<void>;
+    "render:island": (islandResponse: NuxtIslandResponse, context: {
+      event: H3Event;
+      islandContext: NuxtIslandContext;
+    }) => void | Promise<void>;
+  }
 }
-
+declare module "nitropack/types" {
+  interface NitroRuntimeConfigApp {
+    buildAssetsDir: string;
+    cdnURL: string;
+  }
+  interface NitroRuntimeConfig extends RuntimeConfig {}
+  interface NitroRouteConfig {
+    ssr?: boolean;
+    noScripts?: boolean;
+    /** @deprecated Use `noScripts` instead */
+    experimentalNoScripts?: boolean;
+  }
+  interface NitroRouteRules {
+    ssr?: boolean;
+    noScripts?: boolean;
+    /** @deprecated Use `noScripts` instead */
+    experimentalNoScripts?: boolean;
+    appMiddleware?: Record<string, boolean>;
+    appLayout?: string | false;
+  }
+  interface NitroRuntimeHooks {
+    "dev:ssr-logs": (ctx: {
+      logs: LogObject[];
+      path: string;
+    }) => void | Promise<void>;
+    "render:html": (htmlContext: NuxtRenderHTMLContext, context: {
+      event: H3Event;
+    }) => void | Promise<void>;
+    "render:island": (islandResponse: NuxtIslandResponse, context: {
+      event: H3Event;
+      islandContext: NuxtIslandContext;
+    }) => void | Promise<void>;
+  }
+}
+declare module "@nuxt/schema" {
+  interface NuxtHooks {
+    /**
+    * Called when the dev middleware is being registered on the Nitro dev server.
+    * @param handler the Vite or Webpack event handler
+    * @returns Promise
+    */
+    "server:devHandler": (handler: EventHandler, options: {
+      cors: (path: string) => boolean;
+    }) => HookResult;
+    /**
+    * Called before Nitro writes `.nuxt/tsconfig.server.json`, allowing addition of custom references and declarations.
+    * @param options Objects containing `references`, `declarations`
+    * @returns Promise
+    */
+    "nitro:prepare:types": (options: {
+      references: TSReference[];
+      declarations: string[];
+    }) => HookResult;
+    /**
+    * Called before initializing Nitro, allowing customization of Nitro's configuration.
+    * @param nitroConfig The nitro config to be extended
+    * @returns Promise
+    */
+    "nitro:config": (nitroConfig: NitroConfig) => HookResult;
+    /**
+    * Called after Nitro is initialized, which allows registering Nitro hooks and interacting directly with Nitro.
+    * @param nitro The created nitro object
+    * @returns Promise
+    */
+    "nitro:init": (nitro: Nitro) => HookResult;
+    /**
+    * Called before building the Nitro instance.
+    * @param nitro The created nitro object
+    * @returns Promise
+    */
+    "nitro:build:before": (nitro: Nitro) => HookResult;
+    /**
+    * Called after copying public assets. Allows modifying public assets before Nitro server is built.
+    * @param nitro The created nitro object
+    * @returns Promise
+    */
+    "nitro:build:public-assets": (nitro: Nitro) => HookResult;
+  }
+  interface ConfigSchema {
+    /**
+    * Configuration for Nitro.
+    *
+    * @see [Nitro configuration docs](https://nitro.build/config)
+    */
+    nitro: NitroConfig;
+    /**
+    * Global route options applied to matching server routes.
+    *
+    * @experimental This is an experimental feature and API may change in the future.
+    *
+    * @see [Nitro route rules documentation](https://nitro.build/config#routerules)
+    */
+    routeRules: NitroConfig["routeRules"];
+    /**
+    * Nitro server handlers.
+    *
+    * Each handler accepts the following options:
+    * - handler: The path to the file defining the handler. - route: The route under which the handler is available. This follows the conventions of [rou3](https://github.com/h3js/rou3). - method: The HTTP method of requests that should be handled. - middleware: Specifies whether it is a middleware handler. - lazy: Specifies whether to use lazy loading to import the handler.
+    *
+    * @see [`server/` directory documentation](https://nuxt.com/docs/3.x/directory-structure/server)
+    *
+    * @note Files from `server/api`, `server/middleware` and `server/routes` will be automatically registered by Nuxt.
+    *
+    * @example
+    * ```js
+    * serverHandlers: [
+    *   { route: '/path/foo/**:name', handler: '~/server/foohandler.ts' }
+    * ]
+    * ```
+    */
+    serverHandlers: NitroEventHandler[];
+    /**
+    * Nitro development-only server handlers.
+    *
+    * @see [Nitro server routes documentation](https://nitro.build/guide/routing)
+    */
+    devServerHandlers: NitroDevEventHandler[];
+  }
+  interface NuxtConfig {
+    nitro?: NitroConfig;
+  }
+  interface RuntimeConfig {
+    app: NitroRuntimeConfigApp;
+    /** Only available on the server. */
+    nitro?: NitroRuntimeConfig["nitro"];
+  }
+  interface NuxtDebugOptions {
+    /** Debug options for Nitro */
+    nitro?: NitroOptions["debug"];
+  }
+  interface NuxtPage {
+    rules?: NitroRouteConfig;
+  }
+}
+declare module "nuxt/schema" {
+  interface NuxtHooks {
+    /**
+    * Called when the dev middleware is being registered on the Nitro dev server.
+    * @param handler the Vite or Webpack event handler
+    * @returns Promise
+    */
+    "server:devHandler": (handler: EventHandler, options: {
+      cors: (path: string) => boolean;
+    }) => HookResult;
+    /**
+    * Called before Nitro writes `.nuxt/tsconfig.server.json`, allowing addition of custom references and declarations.
+    * @param options Objects containing `references`, `declarations`
+    * @returns Promise
+    */
+    "nitro:prepare:types": (options: {
+      references: TSReference[];
+      declarations: string[];
+    }) => HookResult;
+    /**
+    * Called before initializing Nitro, allowing customization of Nitro's configuration.
+    * @param nitroConfig The nitro config to be extended
+    * @returns Promise
+    */
+    "nitro:config": (nitroConfig: NitroConfig) => HookResult;
+    /**
+    * Called after Nitro is initialized, which allows registering Nitro hooks and interacting directly with Nitro.
+    * @param nitro The created nitro object
+    * @returns Promise
+    */
+    "nitro:init": (nitro: Nitro) => HookResult;
+    /**
+    * Called before building the Nitro instance.
+    * @param nitro The created nitro object
+    * @returns Promise
+    */
+    "nitro:build:before": (nitro: Nitro) => HookResult;
+    /**
+    * Called after copying public assets. Allows modifying public assets before Nitro server is built.
+    * @param nitro The created nitro object
+    * @returns Promise
+    */
+    "nitro:build:public-assets": (nitro: Nitro) => HookResult;
+  }
+  interface ConfigSchema {
+    /**
+    * Configuration for Nitro.
+    *
+    * @see [Nitro configuration docs](https://nitro.build/config)
+    */
+    nitro: NitroConfig;
+    /**
+    * Global route options applied to matching server routes.
+    *
+    * @experimental This is an experimental feature and API may change in the future.
+    *
+    * @see [Nitro route rules documentation](https://nitro.build/config#routerules)
+    */
+    routeRules: NitroConfig["routeRules"];
+    /**
+    * Nitro server handlers.
+    *
+    * Each handler accepts the following options:
+    * - handler: The path to the file defining the handler. - route: The route under which the handler is available. This follows the conventions of [rou3](https://github.com/h3js/rou3). - method: The HTTP method of requests that should be handled. - middleware: Specifies whether it is a middleware handler. - lazy: Specifies whether to use lazy loading to import the handler.
+    *
+    * @see [`server/` directory documentation](https://nuxt.com/docs/3.x/directory-structure/server)
+    *
+    * @note Files from `server/api`, `server/middleware` and `server/routes` will be automatically registered by Nuxt.
+    *
+    * @example
+    * ```js
+    * serverHandlers: [
+    *   { route: '/path/foo/**:name', handler: '~/server/foohandler.ts' }
+    * ]
+    * ```
+    */
+    serverHandlers: NitroEventHandler[];
+    /**
+    * Nitro development-only server handlers.
+    *
+    * @see [Nitro server routes documentation](https://nitro.build/guide/routing)
+    */
+    devServerHandlers: NitroDevEventHandler[];
+  }
+  interface NuxtConfig {
+    nitro?: NitroConfig;
+  }
+  interface RuntimeConfig {
+    app: NitroRuntimeConfigApp;
+    /** Only available on the server. */
+    nitro?: NitroRuntimeConfig["nitro"];
+  }
+  interface NuxtDebugOptions {
+    /** Debug options for Nitro */
+    nitro?: NitroOptions["debug"];
+  }
+  interface NuxtPage {
+    rules?: NitroRouteConfig;
+  }
+}
+//#endregion
+//#region src/index.d.ts
 declare function bundle(nuxt: Nuxt & {
-    _nitro?: Nitro;
+  _nitro?: Nitro;
 }): Promise<void>;
-
-export { bundle };
+//#endregion
+export { bundle };