astro 5.16.6 → 5.16.7

package/dist/types/public/context.d.ts

@@ -5,166 +5,94 @@ import type { AstroCookies } from '../../core/cookies/cookies.js';
 import type { CspDirective, CspHash } from '../../core/csp/config.js';
 import type { AstroSession } from '../../core/session.js';
 import type { AstroComponentFactory } from '../../runtime/server/index.js';
-import type { Params, RewritePayload } from './common.js';
+import type { RewritePayload } from './common.js';
 import type { ValidRedirectStatus } from './config.js';
 import type { AstroInstance, MarkdownInstance, MDXInstance } from './content.js';
 /**
  * Astro global available in all contexts in .astro files
  *
- * [Astro reference](https://docs.astro.build/reference/api-reference/#astro-global)
+ * [Astro reference](https://docs.astro.build/en/reference/api-reference/)
  */
 export interface AstroGlobal<Props extends Record<string, any> = Record<string, any>, Self = AstroComponentFactory, Params extends Record<string, string | undefined> = Record<string, string | undefined>> extends AstroGlobalPartial, AstroSharedContext<Props, Params> {
     /**
-     * A full URL object of the request URL.
-     * Equivalent to: `new URL(Astro.request.url)`
+     * A standard [ResponseInit](https://developer.mozilla.org/en-US/docs/Web/API/Response/Response#init) object describing the outgoing response.
      *
-     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#url)
-     */
-    url: AstroSharedContext['url'];
-    /** Parameters passed to a dynamic page generated using [getStaticPaths](https://docs.astro.build/en/reference/api-reference/#getstaticpaths)
-     *
-     * Example usage:
-     * ```astro
-     * ---
-     * export async function getStaticPaths() {
-     *    return [
-     *     { params: { id: '1' } },
-     *   ];
-     * }
-     *
-     * const { id } = Astro.params;
-     * ---
-     * <h1>{id}</h1>
-     * ```
-     *
-     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#astroparams)
-     */
-    params: AstroSharedContext<Props, Params>['params'];
-    /** List of props passed to this component
-     *
-     * A common way to get specific props is through [destructuring](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment), ex:
-     * ```typescript
-     * const { name } = Astro.props
-     * ```
-     *
-     * [Astro reference](https://docs.astro.build/en/basics/astro-components/#component-props)
-     */
-    props: AstroSharedContext<Props, Params>['props'];
-    /** Information about the current request. This is a standard [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object
-     *
-     * For example, to get a URL object of the current URL, you can use:
-     * ```typescript
-     * const url = new URL(Astro.request.url);
-     * ```
-     *
-     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#astrorequest)
-     */
-    request: Request;
-    /** Information about the outgoing response. This is a standard [ResponseInit](https://developer.mozilla.org/en-US/docs/Web/API/Response/Response#init) object
+     * ## Example
      *
-     * For example, to change the status code you can set a different status on this object:
+     * You can change the status code by assigning a value to this property:
      * ```typescript
      * Astro.response.status = 404;
      * ```
      *
-     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#astroresponse)
+     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#response)
      */
     response: ResponseInit & {
         readonly headers: Headers;
     };
     /**
-     * Get an action result on the server when using a form POST.
-     * Expects the action function as a parameter.
-     * Returns a type-safe result with the action data when
-     * a matching POST request is received
-     * and `undefined` otherwise.
-     *
-     * Example usage:
-     *
-     * ```typescript
-     * import { actions } from 'astro:actions';
-     *
-     * const result = await Astro.getActionResult(actions.myAction);
-     * ```
-     */
-    getActionResult: AstroSharedContext['getActionResult'];
-    /**
-     * Call an Action directly from an Astro page or API endpoint.
-     * Expects the action function as the first parameter,
-     * and the type-safe action input as the second parameter.
-     * Returns a Promise with the action result.
+     * Allows a component to be recursively called.
      *
-     * Example usage:
-     *
-     * ```typescript
-     * import { actions } from 'astro:actions';
-     *
-     * const result = await Astro.callAction(actions.getPost, { postId: 'test' });
-     * ```
-     */
-    callAction: AstroSharedContext['callAction'];
-    /** Redirect to another page
-     *
-     * Example usage:
-     * ```typescript
-     * if(!isLoggedIn) {
-     *   return Astro.redirect('/login');
-     * }
-     * ```
-     *
-     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#astroredirect)
-     */
-    redirect: AstroSharedContext['redirect'];
-    /**
-     * It rewrites to another page. As opposed to redirects, the URL won't change, and Astro will render the HTML emitted
-     * by the rewritten URL passed as argument.
+     * This is useful when you need to render an Astro component from within
+     * itself. `Astro.self` accepts the same properties as the component itself.
      *
      * ## Example
      *
-     * ```js
-     * if (pageIsNotEnabled) {
-     * 	return Astro.rewrite('/fallback-page')
-     * }
+     * ```astro
+     * ---
+     * const { items } = Astro.props;
+     * ---
+     * <ul>
+     *   {items.map((item) => (
+     *     <li>
+     *       {Array.isArray(item) ? (
+     *         <Astro.self items={item} />
+     *       ) : (
+     *         item
+     *       )}
+     *     </li>
+     *   ))}
+     * </ul>
      * ```
-     */
-    rewrite: AstroSharedContext['rewrite'];
-    /**
-     * The route currently rendered. It's stripped of the `srcDir` and the `pages` folder, and it doesn't contain the extension.
-     *
-     * ## Example
-     * - The value when rendering `src/pages/index.astro` will be `/`.
-     * - The value when rendering `src/pages/blog/[slug].astro` will be `/blog/[slug]`.
-     * - The value when rendering `src/pages/[...path].astro` will be `/[...path]`.
-     */
-    routePattern: string;
-    /**
-     * The <Astro.self /> element allows a component to reference itself recursively.
      *
-     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#astroself)
+     * [Astro reference](https://docs.astro.build/en/reference/astro-syntax/#astroself)
      */
     self: Self;
-    /** Utility functions for modifying an Astro component’s slotted children
+    /**
+     * An object containing utility functions for modifying an Astro component’s
+     * slotted children.
      *
-     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#astroslots)
+     * [Astro reference](https://docs.astro.build/en/reference/astro-syntax/#astroslots)
      */
     slots: Record<string, true | undefined> & {
         /**
          * Check whether content for this slot name exists
          *
-         * Example usage:
-         * ```typescript
-         *	if (Astro.slots.has('default')) {
+         * @param {string} slotName - The name of the slot to check.
+         * @returns {boolean} Whether the slot exists.
+         *
+         * ## Example
+         *
+         * ```astro
+         * ---
+         * ---
+         * <slot />
+         * {Astro.slots.has('more') && (
          *   // Do something...
-         *	}
+         * }
          * ```
          *
-         * [Astro reference](https://docs.astro.build/en/reference/api-reference/#astroslots)
+         * [Astro reference](https://docs.astro.build/en/reference/astro-syntax/#astroslotshas)
          */
         has(slotName: string): boolean;
         /**
-         * Asynchronously renders this slot and returns a string
+         * Asynchronously renders the contents of a slot to a string of HTML.
+         *
+         * @param {string} slotName - The name of the slot to render.
+         * @param {any[]} [args] - The additional arguments to pass to the callback.
+         * @returns {Promise<string>} The rendered slot as HTML string.
+         *
+         * ## Examples
          *
-         * Example usage:
          * ```astro
          * ---
          * let html: string = '';
@@ -177,7 +105,6 @@ export interface AstroGlobal<Props extends Record<string, any> = Record<string,
          *
          * A second parameter can be used to pass arguments to a slotted callback
          *
-         * Example usage:
          * ```astro
          * ---
          * html = await Astro.slots.render('default', ["Hello", "World"])
@@ -190,18 +117,19 @@ export interface AstroGlobal<Props extends Record<string, any> = Record<string,
          * </Component>
          * ```
          *
-         * [Astro reference](https://docs.astro.build/en/reference/api-reference/#astroslots)
+         * [Astro reference](https://docs.astro.build/en/reference/astro-syntax/#astroslotsrender)
          */
         render(slotName: string, args?: any[]): Promise<string>;
     };
 }
 /** Union type of supported markdown file extensions */
 type MarkdownFileExtension = (typeof SUPPORTED_MARKDOWN_FILE_EXTENSIONS)[number];
-export interface AstroGlobalPartial {
+export interface AstroGlobalPartial extends Pick<AstroSharedContext, 'site' | 'generator'> {
     /**
      * Fetch local files into your static site setup
      *
-     * Example usage:
+     * ## Example
+     *
      * ```typescript
      * const posts = await Astro.glob('../pages/post/*.md');
      * ```
@@ -222,193 +150,159 @@ export interface AstroGlobalPartial {
      * @deprecated `Astro.glob` is deprecated and will be removed in the next major version of Astro. Use `import.meta.glob` instead: https://vitejs.dev/guide/features.html#glob-import
      */
     glob<T extends Record<string, any>>(globStr: string): Promise<T[]>;
+}
+export interface AstroSharedContext<Props extends Record<string, any> = Record<string, any>, Params extends Record<string, string | undefined> = Record<string, string | undefined>> {
     /**
-     * Returns a [URL](https://developer.mozilla.org/en-US/docs/Web/API/URL) object built from the [site](https://docs.astro.build/en/reference/configuration-reference/#site) config option
+     * The site provided in the astro config, parsed as an instance of `URL`, without base.
+     * `undefined` if the site is not provided in the config.
+     *
+     * ## Example
      *
-     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#astrosite)
+     * ```astro
+     * <link
+     *   rel="alternate"
+     *   type="application/rss+xml"
+     *   title="Your Site's Title"
+     *   href={new URL("rss.xml", Astro.site)}
+     * />
+     * ```
+     *
+     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#site)
      */
     site: URL | undefined;
     /**
-     * Returns a string with the current version of Astro.
+     * A human-readable string representing the Astro version used to create the project. It follows the format "Astro v5.x.x".
      *
-     * Useful for using `<meta name="generator" content={Astro.generator} />` or crediting Astro in a site footer.
+     * ## Example
      *
-     * [HTML Specification for `generator`](https://html.spec.whatwg.org/multipage/semantics.html#meta-generator)
+     * ```astro
+     * <meta name="generator" content={Astro.generator} />
+     * ```
      *
-     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#astrogenerator)
+     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#generator)
      */
     generator: string;
-}
-export interface AstroSharedContext<Props extends Record<string, any> = Record<string, any>, RouteParams extends Record<string, string | undefined> = Record<string, string | undefined>> {
     /**
      * The address (usually IP address) of the user.
      *
      * Throws an error if used within a static site, or within a prerendered page.
-     */
-    clientAddress: string;
-    /**
-     * Utility for getting and setting the values of cookies.
-     */
-    cookies: AstroCookies;
-    /**
-     * Utility for handling sessions.
-     */
-    session?: AstroSession;
-    /**
-     * Information about the current request. This is a standard [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object
-     */
-    request: Request;
-    /**
-     * A full URL object of the request URL.
-     */
-    url: URL;
-    /**
-     * The origin pathname of the request URL.
-     * Useful to track the original URL before rewrites were applied.
-     */
-    originPathname: string;
-    /**
-     * Get action result on the server when using a form POST.
-     */
-    getActionResult: <TAccept extends ActionAccept, TInputSchema extends z.ZodType, TAction extends ActionClient<unknown, TAccept, TInputSchema>>(action: TAction) => ActionReturnType<TAction> | undefined;
-    /**
-     * Call action handler from the server.
-     */
-    callAction: <TAccept extends ActionAccept, TInputSchema extends z.ZodType, TOutput, TAction extends ActionClient<TOutput, TAccept, TInputSchema> | ActionClient<TOutput, TAccept, TInputSchema>['orThrow']>(action: TAction, input: Parameters<TAction>[0]) => Promise<ActionReturnType<TAction>>;
-    /**
-     * Route parameters for this request if this is a dynamic route.
-     */
-    params: RouteParams;
-    /**
-     * List of props returned for this path by `getStaticPaths` (**Static Only**).
-     */
-    props: Props;
-    /**
-     * Redirect to another page (**SSR Only**).
-     */
-    redirect(path: string, status?: ValidRedirectStatus): Response;
-    /**
-     * It rewrites to another page. As opposed to redirects, the URL won't change, and Astro will render the HTML emitted
-     * by the rerouted URL passed as argument.
      *
      * ## Example
      *
-     * ```js
-     * if (pageIsNotEnabled) {
-     * 	return Astro.rewrite('/fallback-page')
+     * ```ts
+     * import type { APIContext } from 'astro';
+     *
+     * export function GET({ clientAddress }: APIContext) {
+     *   return new Response(`Your IP address is: ${clientAddress}`);
      * }
      * ```
+     *
+     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#clientaddress)
      */
-    rewrite(rewritePayload: RewritePayload): Promise<Response>;
-    /**
-     * Object accessed via Astro middleware
-     */
-    locals: App.Locals;
-    /**
-     * The current locale that is computed from the `Accept-Language` header of the browser (**SSR Only**).
-     */
-    preferredLocale: string | undefined;
-    /**
-     * The list of locales computed from the `Accept-Language` header of the browser, sorted by quality value (**SSR Only**).
-     */
-    preferredLocaleList: string[] | undefined;
-    /**
-     * The current locale computed from the URL of the request. It matches the locales in `i18n.locales`, and returns `undefined` otherwise.
-     */
-    currentLocale: string | undefined;
+    clientAddress: string;
     /**
-     * Whether the current route is prerendered or not.
+     * An object containing utilities for reading and manipulating the values of cookies in on-demand routes.
+     *
+     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#cookies)
      */
-    isPrerendered: boolean;
+    cookies: AstroCookies;
     /**
-     * It exposes utilities to control CSP headers
+     * An object containing utilities for handling sessions in on-demand rendered routes.
+     *
+     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#session)
      */
-    csp: AstroSharedContextCsp;
-}
-export type AstroSharedContextCsp = {
+    session?: AstroSession;
     /**
-     * It adds a specific CSP directive to the route being rendered.
+     * A standard [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing information about the current request.
      *
      * ## Example
      *
-     * ```js
-     * ctx.insertDirective("default-src 'self' 'unsafe-inline' https://example.com")
+     * To get a URL object of the current URL, you can use:
+     * ```typescript
+     * const url = new URL(Astro.request.url);
      * ```
+     *
+     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#request)
      */
-    insertDirective: (directive: CspDirective) => void;
+    request: Request;
     /**
-     * It set the resource for the directive `style-src` in the route being rendered. It overrides Astro's default.
+     * A URL object constructed from the current `request.url` value. This is
+     * equivalent to doing `new URL(context.request.url)`.
      *
      * ## Example
      *
-     * ```js
-     * ctx.insertStyleResource("https://styles.cdn.example.com/")
+     * ```astro
+     * <p>The current URL is: {Astro.url}</p>
+     * <p>The current URL pathname is: {Astro.url.pathname}</p>
+     * <p>The current URL origin is: {Astro.url.origin}</p>
      * ```
+     *
+     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#url)
      */
-    insertStyleResource: (payload: string) => void;
+    url: URL;
     /**
-     * Insert a single style hash to the route being rendered.
+     * The origin pathname of the request URL.
+     * Useful to track the original URL before rewrites were applied.
      *
      * ## Example
      *
-     * ```js
-     * ctx.insertStyleHash("sha256-1234567890abcdef1234567890")
+     * ```astro
+     * <p>The origin path is {Astro.originPathname}</p>
+     * <p>The rewritten path is {Astro.url.pathname}</p>
      * ```
+     *
+     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#originpathname)
      */
-    insertStyleHash: (hash: CspHash) => void;
+    originPathname: string;
     /**
-     * It set the resource for the directive `script-src` in the route being rendered.
+     * A function that returns the result of an Action submission when using a form POST.
+     *
+     * This accepts an action function as an argument and returns a type-safe
+     * data or error object when a submission is received. Otherwise, it will
+     * return undefined.
+     *
+     * @param {TAction} action - The action function to process.
+     * @returns {ActionReturnType<TAction> | undefined} An object describing the result of an action.
      *
      * ## Example
      *
-     * ```js
-     * ctx.insertScriptResource("https://scripts.cdn.example.com/")
+     * ```astro
+     * import { actions } from 'astro:actions';
+     *
+     * const result = await Astro.getActionResult(actions.myAction);
      * ```
+     *
+     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#getactionresult)
      */
-    insertScriptResource: (resource: string) => void;
+    getActionResult: <TAccept extends ActionAccept, TInputSchema extends z.ZodType, TAction extends ActionClient<unknown, TAccept, TInputSchema>>(action: TAction) => ActionReturnType<TAction> | undefined;
     /**
-     * Insert a single script hash to the route being rendered.
+     * A function used to call an Action handler directly from your Astro
+     * component or API endpoint.
+     *
+     * This accepts an Action function and a type-safe action input, and returns
+     * the result of the action as a Promise.
      *
      * ## Example
      *
-     * ```js
-     * ctx.insertScriptHash("sha256-1234567890abcdef1234567890")
-     * ```
-     */
-    insertScriptHash: (hash: CspHash) => void;
-};
-/**
- * The `APIContext` is the object made available to endpoints and middleware.
- * It is a subset of the `Astro` global object available in pages.
- *
- * [Reference](https://docs.astro.build/en/reference/api-reference/#endpoint-context)
- */
-export interface APIContext<Props extends Record<string, any> = Record<string, any>, APIParams extends Record<string, string | undefined> = Record<string, string | undefined>> extends AstroSharedContext<Props, Params> {
-    /**
-     * The site provided in the astro config, parsed as an instance of `URL`, without base.
-     * `undefined` if the site is not provided in the config.
-     */
-    site: URL | undefined;
-    /**
-     * A human-readable string representing the Astro version used to create the project.
-     * For example, `"Astro v1.1.1"`.
-     */
-    generator: string;
-    /**
-     * The url of the current request, parsed as an instance of `URL`.
+     * ```typescript
+     * import { actions } from 'astro:actions';
      *
-     * Equivalent to:
-     * ```ts
-     * new URL(context.request.url)
+     * const result = await Astro.callAction(actions.getPost, { postId: 'test' });
      * ```
+     *
+     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#callaction)
+     *
+     * @param {TAction} action - Any Action function.
+     * @param {Parameters<TAction>[0]} input - Any input that the given action receives.
      */
-    url: AstroSharedContext['url'];
+    callAction: <TAccept extends ActionAccept, TInputSchema extends z.ZodType, TOutput, TAction extends ActionClient<TOutput, TAccept, TInputSchema> | ActionClient<TOutput, TAccept, TInputSchema>['orThrow']>(action: TAction, input: Parameters<TAction>[0]) => Promise<ActionReturnType<TAction>>;
     /**
-     * Parameters matching the page’s dynamic route pattern.
-     * In static builds, this will be the `params` generated by `getStaticPaths`.
-     * In SSR builds, this can be any path segments matching the dynamic route pattern.
+     * An object containing the values of dynamic route segments matched for a request.
+     *
+     * In static builds, this will be the `params` returned by [`getStaticPaths()`](https://docs.astro.build/en/reference/api-reference/#getstaticpaths). With on-demand rendering, `params` can be any value matching the path segments in the dynamic route pattern.
+     *
+     * ## Example
      *
-     * Example usage:
      * ```ts
      * import type { APIContext } from "astro"
      *
@@ -420,18 +314,19 @@ export interface APIContext<Props extends Record<string, any> = Record<string, a
      *   ];
      * }
      *
-     * export async function GET({ params }: APIContext) {
-     *   return new Response(`Hello user ${params.id}!`)
+     * export function GET({ params }: APIContext): Response {
+     *   return new Response(`The current id is ${params.id}.`);
      * }
      * ```
      *
-     * [Reference](https://docs.astro.build/en/reference/api-reference/#contextparams)
+     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#params)
      */
-    params: AstroSharedContext<Props, APIParams>['params'];
+    params: Params;
     /**
-     * List of props passed from `getStaticPaths`. Only available to static builds.
+     * An object containing any values that have been passed as component attributes. In static builds, this can also be the `props` returned by [`getStaticPaths()`](https://docs.astro.build/en/reference/api-reference/#getstaticpaths).
+     *
+     * ## Example
      *
-     * Example usage:
      * ```ts
      * import type { APIContext } from "astro"
      *
@@ -448,13 +343,20 @@ export interface APIContext<Props extends Record<string, any> = Record<string, a
      * }
      * ```
      *
-     * [Reference](https://docs.astro.build/en/reference/api-reference/#contextprops)
+     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#props)
      */
-    props: AstroSharedContext<Props, APIParams>['props'];
+    props: Props;
     /**
      * Create a response that redirects to another page.
      *
-     * Example usage:
+     * This accepts a custom status code when redirecting for on-demand rendered routes only.
+     *
+     * @param {string} path - The path to redirect to.
+     * @param {ValidRedirectStatus} [status] - An optional HTTP status code.
+     * @returns {Response} A Response object describing the redirection.
+     *
+     * ## Example
+     *
      * ```ts
      * // src/pages/secret.ts
      * export function GET({ redirect }) {
@@ -462,12 +364,18 @@ export interface APIContext<Props extends Record<string, any> = Record<string, a
      * }
      * ```
      *
-     * [Reference](https://docs.astro.build/en/guides/api-reference/#contextredirect)
+     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#redirect)
      */
-    redirect: AstroSharedContext['redirect'];
+    redirect: (path: string, status?: ValidRedirectStatus) => Response;
     /**
-     * It reroutes to another page. As opposed to redirects, the URL won't change, and Astro will render the HTML emitted
-     * by the rerouted URL passed as argument.
+     * Allows you to serve content from a different URL or path without
+     * redirecting the browser to a new page.
+     *
+     * As opposed to redirects, the URL won't change, and Astro will render the
+     * HTML emitted by the rerouted URL passed as argument.
+     *
+     * @param {RewritePayload} rewritePayload - The location of the path.
+     * @returns {Promise<Response>} A Response object describing the rewrite.
      *
      * ## Example
      *
@@ -477,14 +385,16 @@ export interface APIContext<Props extends Record<string, any> = Record<string, a
      *   return ctx.rewrite(new URL("../"), ctx.url);
      * }
      * ```
+     *
+     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#rewrite)
      */
-    rewrite: AstroSharedContext['rewrite'];
+    rewrite: (rewritePayload: RewritePayload) => Promise<Response>;
     /**
      * An object that middlewares can use to store extra information related to the request.
      *
      * It will be made available to pages as `Astro.locals`, and to endpoints as `context.locals`.
      *
-     * Example usage:
+     * ## Example
      *
      * ```ts
      * // src/middleware.ts
@@ -495,7 +405,7 @@ export interface APIContext<Props extends Record<string, any> = Record<string, a
      *   return next();
      * });
      * ```
-     * Inside a `.astro` file:
+     * You can then access the value inside a `.astro` file:
      * ```astro
      * ---
      * // src/pages/index.astro
@@ -504,47 +414,156 @@ export interface APIContext<Props extends Record<string, any> = Record<string, a
      * <h1>{greeting}</h1>
      * ```
      *
-     * [Reference](https://docs.astro.build/en/reference/api-reference/#contextlocals)
+     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#locals)
      */
     locals: App.Locals;
     /**
-     * Available only when `i18n` configured and in SSR.
+     * A computed value to find the best match between your visitor’s browser
+     * language preferences and the locales supported by your site.
      *
-     * It represents the preferred locale of the user. It's computed by checking the supported locales in `i18n.locales`
-     * and locales supported by the users's browser via the header `Accept-Language`
+     * This property is only available for routes rendered on demand and cannot
+     * be used on prerendered, static pages.
      *
-     * For example, given `i18n.locales` equals to `['fr', 'de']`, and the `Accept-Language` value equals to `en, de;q=0.2, fr;q=0.6`, the
-     * `Astro.preferredLanguage` will be `fr` because `en` is not supported, its [quality value] is the highest.
+     * The preferred locale of the user is computed by checking the supported
+     * locales in `i18n.locales` and locales supported by the users's browser via
+     * the header `Accept-Language`.
      *
-     * [quality value]: https://developer.mozilla.org/en-US/docs/Glossary/Quality_values
+     * ## Example
+     *
+     * Given `i18n.locales` equals to `['fr', 'de']`, and the `Accept-Language` value equals to `en, de;q=0.2, fr;q=0.6`, the
+     * `Astro.preferredLanguage` will be `fr` because `en` is not supported, its [quality value](https://developer.mozilla.org/en-US/docs/Glossary/Quality_values) is the highest.
+     *
+     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#preferredlocale)
      */
     preferredLocale: string | undefined;
     /**
-     * Available only when `i18n` configured and in SSR.
+     * Represents the list of all locales, sorted via [quality value](https://developer.mozilla.org/en-US/docs/Glossary/Quality_values), that are both
+     * requested by the browser and supported by your website.
      *
-     * It represents the list of the preferred locales that are supported by the application. The list is sorted via [quality value].
+     * This property is only available for routes rendered on demand and cannot
+     * be used on prerendered, static pages.
      *
-     * For example, given `i18n.locales` equals to `['fr', 'pt', 'de']`, and the `Accept-Language` value equals to `en, de;q=0.2, fr;q=0.6`, the
-     * `Astro.preferredLocaleList` will be equal to `['fs', 'de']` because `en` isn't supported, and `pt` isn't part of the locales contained in the
-     * header.
+     * When the `Accept-Header` is `*`, the original `i18n.locales` are returned.
+     * The value `*` means no preferences, so Astro returns all the supported locales.
      *
-     * When the `Accept-Header` is `*`, the original `i18n.locales` are returned. The value `*` means no preferences, so Astro returns all the supported locales.
+     * ## Example
+     *
+     * Given `i18n.locales` equals to `['fr', 'pt', 'de']`, and the
+     * `Accept-Language` value equals to `en, de;q=0.2, fr;q=0.6`, the
+     * `Astro.preferredLocaleList` will be equal to `['fs', 'de']` because `en`
+     * isn't supported, and `pt` isn't part of the locales contained in the
+     * header.
      *
-     * [quality value]: https://developer.mozilla.org/en-US/docs/Glossary/Quality_values
+     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#preferredlocalelist)
      */
     preferredLocaleList: string[] | undefined;
     /**
      * The current locale computed from the URL of the request. It matches the locales in `i18n.locales`, and returns `undefined` otherwise.
+     *
+     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#currentlocale)
      */
     currentLocale: string | undefined;
+    /**
+     * Whether the current route is prerendered or not.
+     *
+     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#isprerendered)
+     */
+    isPrerendered: boolean;
+    /**
+     * It exposes utilities to control CSP headers
+     *
+     * [Astro reference](https://docs.astro.build/en/reference/experimental-flags/csp/)
+     */
+    csp: {
+        /**
+         * It adds a specific CSP directive to the route being rendered.
+         *
+         * @param {CspDirective} directive - The directive to add to the current page.
+         *
+         * ## Example
+         *
+         * ```js
+         * ctx.insertDirective("default-src 'self' 'unsafe-inline' https://example.com")
+         * ```
+         *
+         * [Astro reference](https://docs.astro.build/en/reference/experimental-flags/csp/#cspinsertdirective)
+         */
+        insertDirective: (directive: CspDirective) => void;
+        /**
+         * It set the resource for the directive `style-src` in the route being rendered. It overrides Astro's default.
+         *
+         * @param {string} payload - The source to insert in the `style-src` directive.
+         *
+         * ## Example
+         *
+         * ```js
+         * ctx.insertStyleResource("https://styles.cdn.example.com/")
+         * ```
+         *
+         * [Astro reference](https://docs.astro.build/en/reference/experimental-flags/csp/#cspinsertstyleresource)
+         */
+        insertStyleResource: (payload: string) => void;
+        /**
+         * Insert a single style hash to the route being rendered.
+         *
+         * @param {CspHash} hash - The hash to insert in the `style-src` directive.
+         *
+         * ## Example
+         *
+         * ```js
+         * ctx.insertStyleHash("sha256-1234567890abcdef1234567890")
+         * ```
+         *
+         * [Astro reference](https://docs.astro.build/en/reference/experimental-flags/csp/#cspinsertstylehash)
+         */
+        insertStyleHash: (hash: CspHash) => void;
+        /**
+         * It set the resource for the directive `script-src` in the route being rendered.
+         *
+         * @param {string} resource - The source to insert in the `script-src` directive.
+         *
+         * ## Example
+         *
+         * ```js
+         * ctx.insertScriptResource("https://scripts.cdn.example.com/")
+         * ```
+         *
+         * [Astro reference](https://docs.astro.build/en/reference/experimental-flags/csp/#cspinsertscriptresource)
+         */
+        insertScriptResource: (resource: string) => void;
+        /**
+         * Insert a single script hash to the route being rendered.
+         *
+         * @param {CspHash} hash - The hash to insert in the `script-src` directive.
+         *
+         * ## Example
+         *
+         * ```js
+         * ctx.insertScriptHash("sha256-1234567890abcdef1234567890")
+         * ```
+         *
+         * [Astro reference](https://docs.astro.build/en/reference/experimental-flags/csp/#cspinsertscripthash)
+         */
+        insertScriptHash: (hash: CspHash) => void;
+    };
     /**
      * The route currently rendered. It's stripped of the `srcDir` and the `pages` folder, and it doesn't contain the extension.
      *
      * ## Example
+     *
      * - The value when rendering `src/pages/index.astro` will be `/`.
      * - The value when rendering `src/pages/blog/[slug].astro` will be `/blog/[slug]`.
      * - The value when rendering `src/pages/[...path].astro` will be `/[...path]`.
+     *
+     * [Astro reference](https://docs.astro.build/en/reference/api-reference/#routepattern)
      */
     routePattern: string;
 }
+/**
+ * The `APIContext` is the object made available to endpoints and middleware.
+ * It is a subset of the `Astro` global object available in pages.
+ *
+ * [Astro reference](https://docs.astro.build/en/reference/api-reference/)
+ */
+export type APIContext<Props extends Record<string, any> = Record<string, any>, Params extends Record<string, string | undefined> = Record<string, string | undefined>> = AstroSharedContext<Props, Params>;
 export {};