Skip to main content
Using Deno in production at your company? Earn free Deno merch.
Give us feedback
Module

x/fresh/src/server/types.ts

The next-gen web framework.
Extremely Popular
Go to Latest
File
import { ComponentType } from "preact";import { ConnInfo, rutt, ServeInit } from "./deps.ts";import { InnerRenderFunction, RenderContext } from "./render.ts";
// --- APPLICATION CONFIGURATION ---
export type StartOptions = ServeInit & FreshOptions & { /** * UNSTABLE: use the `Deno.serve` API as the underlying HTTP server instead of * the `std/http` API. Do not use this in production. * * This option is experimental and may be removed in a future Fresh release. */ experimentalDenoServe?: boolean;};
export interface FreshOptions { render?: RenderFunction; plugins?: Plugin[]; staticDir?: string;}
export type RenderFunction = ( ctx: RenderContext, render: InnerRenderFunction,) => void | Promise<void>;
/// --- ROUTES ---
// deno-lint-ignore no-explicit-anyexport interface PageProps<T = any> { /** The URL of the request that resulted in this page being rendered. */ url: URL;
/** The route matcher (e.g. /blog/:id) that the request matched for this page * to be rendered. */ route: string;
/** * The parameters that were matched from the route. * * For the `/foo/:bar` route with url `/foo/123`, `params` would be * `{ bar: '123' }`. For a route with no matchers, `params` would be `{}`. For * a wildcard route, like `/foo/:path*` with url `/foo/bar/baz`, `params` would * be `{ path: 'bar/baz' }`. */ params: Record<string, string>;
/** * Additional data passed into `HandlerContext.render`. Defaults to * `undefined`. */ data: T;}
export interface RouteConfig { /** * A route override for the page. This is useful for pages where the route * can not be expressed through the filesystem routing capabilities. * * The route override must be a path-to-regexp compatible route matcher. */ routeOverride?: string;
/** * If Content-Security-Policy should be enabled for this page. If 'true', a * locked down policy will be used that allows only the scripts and styles * that are generated by fresh. Additional scripts and styles can be added * using the `useCSP` hook. */ csp?: boolean;}
export interface HandlerContext<Data = unknown, State = Record<string, unknown>> extends ConnInfo { params: Record<string, string>; render: (data?: Data) => Response | Promise<Response>; renderNotFound: () => Response | Promise<Response>; state: State;}
// deno-lint-ignore no-explicit-anyexport type Handler<T = any, State = Record<string, unknown>> = ( req: Request, ctx: HandlerContext<T, State>,) => Response | Promise<Response>;
// deno-lint-ignore no-explicit-anyexport type Handlers<T = any, State = Record<string, unknown>> = { [K in typeof rutt.METHODS[number]]?: Handler<T, State>;};
export interface RouteModule { default?: ComponentType<PageProps>; // deno-lint-ignore no-explicit-any handler?: Handler<any, any> | Handlers<any, any>; config?: RouteConfig;}
// deno-lint-ignore no-explicit-anyexport interface Route<Data = any> { pattern: string; url: string; name: string; component?: ComponentType<PageProps<Data>>; handler: Handler<Data> | Handlers<Data>; csp: boolean;}
// --- APP ---
export interface AppProps { Component: ComponentType<Record<never, never>>;}
export interface AppModule { default: ComponentType<AppProps>;}
// --- UNKNOWN PAGE ---
export interface UnknownPageProps { /** The URL of the request that resulted in this page being rendered. */ url: URL;
/** The route matcher (e.g. /blog/:id) that the request matched for this page * to be rendered. */ route: string;}
export interface UnknownHandlerContext<State = Record<string, unknown>> extends ConnInfo { render: () => Response | Promise<Response>; state: State;}
export type UnknownHandler = ( req: Request, ctx: UnknownHandlerContext,) => Response | Promise<Response>;
export interface UnknownPageModule { default?: ComponentType<UnknownPageProps>; handler?: UnknownHandler; config?: RouteConfig;}
export interface UnknownPage { pattern: string; url: string; name: string; component?: ComponentType<UnknownPageProps>; handler: UnknownHandler; csp: boolean;}
// --- ERROR PAGE ---
export interface ErrorPageProps { /** The URL of the request that resulted in this page being rendered. */ url: URL;
/** The route matcher (e.g. /blog/:id) that the request matched for this page * to be rendered. */ pattern: string;
/** The error that caused the error page to be loaded. */ error: unknown;}
export interface ErrorHandlerContext<State = Record<string, unknown>> extends ConnInfo { error: unknown; render: () => Response | Promise<Response>; state: State;}export type ErrorHandler = ( req: Request, ctx: ErrorHandlerContext,) => Response | Promise<Response>;
export interface ErrorPageModule { default?: ComponentType<ErrorPageProps>; handler?: ErrorHandler; config?: RouteConfig;}
export interface ErrorPage { pattern: string; url: string; name: string; component?: ComponentType<ErrorPageProps>; handler: ErrorHandler; csp: boolean;}
// --- MIDDLEWARES ---
export interface MiddlewareHandlerContext<State = Record<string, unknown>> extends ConnInfo { next: () => Promise<Response>; state: State;}
export interface MiddlewareRoute extends Middleware { /** * path-to-regexp style url path */ pattern: string; /** * URLPattern of the route */ compiledPattern: URLPattern;}
export type MiddlewareHandler<State = Record<string, unknown>> = ( req: Request, ctx: MiddlewareHandlerContext<State>,) => Response | Promise<Response>;
// deno-lint-ignore no-explicit-anyexport interface MiddlewareModule<State = any> { handler: MiddlewareHandler<State> | MiddlewareHandler<State>[];}
export interface Middleware<State = Record<string, unknown>> { handler: MiddlewareHandler<State> | MiddlewareHandler<State>[];}
// --- ISLANDS ---
export interface IslandModule { // deno-lint-ignore no-explicit-any default: ComponentType<any>;}
export interface Island { id: string; name: string; url: string; component: ComponentType<unknown>;}
// --- PLUGINS ---
export interface Plugin { /** The name of the plugin. Must be snake-case. */ name: string;
/** A map of a snake-case names to a import specifiers. The entrypoints * declared here can later be used in the "scripts" option of * `PluginRenderResult` to load the entrypoint's code on the client. */ entrypoints?: Record<string, string>;
/** The render hook is called on the server every time some JSX needs to * be turned into HTML. The render hook needs to call the `ctx.render` * function exactly once. * * The hook can return a `PluginRenderResult` object that can do things like * inject CSS into the page, or load additional JS files on the client. */ render?(ctx: PluginRenderContext): PluginRenderResult;}
export interface PluginRenderContext { render: PluginRenderFunction;}
export interface PluginRenderResult { /** CSS styles to be injected into the page. */ styles?: PluginRenderStyleTag[]; /** JS scripts to ship to the client. */ scripts?: PluginRenderScripts[];}
export interface PluginRenderStyleTag { cssText: string; media?: string; id?: string;}
export interface PluginRenderScripts { /** The "key" of the entrypoint (as specified in `Plugin.entrypoints`) for the * script that should be loaded. The script must be an ES module that exports * a default function. * * The default function is invoked with the `state` argument specified below. */ entrypoint: string; /** The state argument that is passed to the default export invocation of the * entrypoint's default export. The state must be JSON-serializable. */ state: unknown;}
export type PluginRenderFunction = () => PluginRenderFunctionResult;
export interface PluginRenderFunctionResult { /** The HTML text that was rendered. */ htmlText: string; /** If the renderer encountered any islands that require hydration on the * client. */ requiresHydration: boolean;}