import { ComponentChildren, ComponentType, VNode } from "preact"; import * as router from "./router.ts"; import { InnerRenderFunction, RenderContext } from "./render.ts"; import { Manifest } from "./mod.ts"; export interface DenoConfig { imports?: Record; importMap?: string; tasks?: Record; lint?: { rules: { tags?: string[] }; exclude?: string[]; }; fmt?: { exclude?: string[]; }; exclude?: string[]; compilerOptions?: { jsx?: string; jsxImportSource?: string; }; } // --- APPLICATION CONFIGURATION --- export interface FreshConfig { build?: { /** * The directory to write generated files to when `dev.ts build` is run. * This can be an absolute path, a file URL or a relative path. */ outDir?: string; /** * This sets the target environment for the generated code. Newer * language constructs will be transformed to match the specified * support range. See https://esbuild.github.io/api/#target * @default {"es2022"} */ target?: string | string[]; }; render?: RenderFunction; plugins?: Plugin[]; staticDir?: string; router?: RouterOptions; server?: Partial; // Older versions of Fresh merged the `Deno.ServeTlsOptions` directly. // We've moved this to `server`. /** * Server private key in PEM format * @deprecated Use `server.cert` instead */ cert?: string; /** * Cert chain in PEM format * @deprecated Use `server.key` instead */ key?: string; /** * The port to listen on. * @default {8000} * @deprecated Use `server.port` instead */ port?: number; /** * A literal IP address or host name that can be resolved to an IP address. * * __Note about `0.0.0.0`__ While listening `0.0.0.0` works on all platforms, * the browsers on Windows don't work with the address `0.0.0.0`. * You should show the message like `server running on localhost:8080` instead of * `server running on 0.0.0.0:8080` if your program supports Windows. * * @default {"0.0.0.0"} * @deprecated Use `server.hostname` instead */ hostname?: string; /** * An {@linkcode AbortSignal} to close the server and all connections. * @deprecated Use `server.signal` instead */ signal?: AbortSignal; /** * Sets `SO_REUSEPORT` on POSIX systems. * @deprecated Use `server.reusePort` instead */ reusePort?: boolean; /** * The handler to invoke when route handlers throw an error. * @deprecated Use `server.onError` instead */ onError?: (error: unknown) => Response | Promise; /** * The callback which is called when the server starts listening. * @deprecated Use `server.onListen` instead */ onListen?: (params: { hostname: string; port: number }) => void; } export interface InternalFreshState { config: ResolvedFreshConfig; manifest: Manifest; loadSnapshot: boolean; didLoadSnapshot: boolean; denoJsonPath: string; denoJson: DenoConfig; build: boolean; } export interface ResolvedFreshConfig { dev: boolean; build: { outDir: string; target: string | string[]; }; render: RenderFunction; plugins: Plugin[]; staticDir: string; router?: RouterOptions; server: Partial; basePath: string; } export interface RouterOptions { /** * Controls whether Fresh will append a trailing slash to the URL. * @default {false} */ trailingSlash?: boolean; /** * Configures the pattern of files to ignore in islands and routes. * * By default Fresh will ignore test files, * for example files with a `.test.ts` or a `_test.ts` suffix. * * @default {/(?:[^/]*_|[^/]*\.|)test\.(?:ts|tsx|mts|js|mjs|jsx|)\/*$/} */ ignoreFilePattern?: RegExp; /** * Serve fresh from a base path instead of from the root. * "/foo/bar" -> http://localhost:8000/foo/bar * @default {undefined} */ basePath?: string; } export type RenderFunction = ( ctx: RenderContext, render: InnerRenderFunction, ) => void | Promise; /// --- ROUTES --- // deno-lint-ignore no-explicit-any export type PageProps> = Omit< FreshContext< S, T >, "render" | "next" | "renderNotFound" >; export interface StaticFile { /** The URL to the static file on disk. */ localUrl: URL; /** The path to the file as it would be in the incoming request. */ path: string; /** The size of the file. */ size: number; /** The content-type of the file. */ contentType: string; /** Hash of the file contents. */ etag: string; } export interface FreshContext< State = Record, // deno-lint-ignore no-explicit-any Data = any, NotFoundData = Data, > { /** @types deprecated */ localAddr?: Deno.NetAddr; remoteAddr: Deno.NetAddr; url: URL; basePath: string; route: string; /** @deprecated Use `.route` instead */ pattern: string; destination: router.DestinationKind; params: Record; isPartial: boolean; state: State; config: ResolvedFreshConfig; data: Data; /** The error that caused the error page to be loaded. */ error?: unknown; /** Sringified code frame of the error rendering failed (only in development mode) */ codeFrame?: unknown; // These properties may be different renderNotFound: (data?: NotFoundData) => Response | Promise; render: ( data?: Data, options?: RenderOptions, ) => Response | Promise; Component: ComponentType; next: () => Promise; } /** * Context passed to async route components. */ // deno-lint-ignore no-explicit-any export type RouteContext> = Omit< FreshContext< S, T >, "next" | "render" >; 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; /** * Skip already inherited layouts * Default: `false` */ skipInheritedLayouts?: boolean; /** * Skip rendering the `routes/_app` template * Default: `false` */ skipAppWrapper?: boolean; } // deno-lint-ignore no-empty-interface export interface RenderOptions extends ResponseInit {} export type ServeHandlerInfo = { /** * Backwards compatible with std/server * @deprecated */ localAddr?: Deno.NetAddr; remoteAddr: Deno.NetAddr; }; export type ServeHandler = ( request: Request, info: ServeHandlerInfo, ) => Response | Promise; // deno-lint-ignore no-explicit-any export type Handler> = ( req: Request, ctx: FreshContext, ) => Response | Promise; // deno-lint-ignore no-explicit-any export type Handlers> = { [K in router.KnownMethod]?: Handler; }; export interface RouteModule { default?: PageComponent; // deno-lint-ignore no-explicit-any handler?: Handler | Handlers; config?: RouteConfig; } // deno-lint-ignore no-explicit-any export type AsyncRoute> = ( req: Request, ctx: FreshContext, ) => Promise; // deno-lint-ignore no-explicit-any export type PageComponent> = | ComponentType> | AsyncRoute // deno-lint-ignore no-explicit-any | ((props: any) => VNode | ComponentChildren); // deno-lint-ignore no-explicit-any export interface Route { baseRoute: BaseRoute; pattern: string; url: string; name: string; component?: PageComponent | AsyncLayout | AsyncRoute; handler: Handler | Handlers; csp: boolean; appWrapper: boolean; inheritLayouts: boolean; } // --- APP --- export interface AppModule { default: ComponentType | AsyncLayout; } // deno-lint-ignore no-explicit-any export type AsyncLayout> = ( req: Request, ctx: FreshContext, ) => Promise; export interface LayoutConfig { /** * Skip already inherited layouts * Default: `false` */ skipAppWrapper?: boolean; /** * Skip rendering the `routes/_app`. * Default: `false` */ skipInheritedLayouts?: boolean; } export interface LayoutModule { // deno-lint-ignore no-explicit-any handler?: Handler | Handlers; default: ComponentType | AsyncLayout; config?: LayoutConfig; } export interface LayoutRoute { baseRoute: BaseRoute; // deno-lint-ignore no-explicit-any handler?: Handler | Handlers; component: LayoutModule["default"]; appWrapper: boolean; inheritLayouts: boolean; } // --- UNKNOWN PAGE --- export type UnknownHandler = ( req: Request, ctx: FreshContext, ) => Response | Promise; export interface UnknownPageModule { default?: PageComponent; handler?: UnknownHandler; config?: RouteConfig; } export interface UnknownPage { baseRoute: BaseRoute; pattern: string; url: string; name: string; component?: PageComponent; handler: UnknownHandler; csp: boolean; appWrapper: boolean; inheritLayouts: boolean; } export type UnknownRenderFunction = ( req: Request, ctx: FreshContext, ) => Promise; // --- ERROR PAGE --- // Nominal/Branded type. Ensures that the string has the expected format export type BaseRoute = string & { readonly __brand: unique symbol }; export type ErrorHandler = ( req: Request, ctx: FreshContext, ) => Response | Promise; export interface ErrorPageModule { default?: PageComponent; handler?: ErrorHandler; config?: RouteConfig; } export interface ErrorPage { baseRoute: BaseRoute; pattern: string; url: string; name: string; component?: PageComponent; handler: ErrorHandler; csp: boolean; appWrapper: boolean; inheritLayouts: boolean; } // --- MIDDLEWARES --- export interface MiddlewareRoute { baseRoute: BaseRoute; module: Middleware; } export type MiddlewareHandler> = ( req: Request, ctx: FreshContext, ) => Response | Promise; // deno-lint-ignore no-explicit-any export interface MiddlewareModule { handler: MiddlewareHandler | MiddlewareHandler[]; } export interface Middleware> { handler: MiddlewareHandler | MiddlewareHandler[]; } // --- ISLANDS --- export interface IslandModule { // deno-lint-ignore no-explicit-any [key: string]: ComponentType | unknown; } export interface Island { id: string; name: string; url: string; component: ComponentType; exportName: string; } // --- 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; /** 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; /** The asynchronous render hook is called on the server every time some * JSX needs to be turned into HTML, wrapped around all synchronous render * hooks. The render hook needs to call the `ctx.renderAsync` function * exactly once, and await the result. * * This is useful for when plugins are generating styles and scripts with * asynchronous dependencies. Unlike the synchronous render hook, async render * hooks for multiple pages can be running at the same time. This means that * unlike the synchronous render hook, you can not use global variables to * propagate state between the render hook and the renderer. */ renderAsync?(ctx: PluginAsyncRenderContext): Promise; /** * Called before running the Fresh build task */ buildStart?(config: ResolvedFreshConfig): Promise | void; /** * Called after completing the Fresh build task */ buildEnd?(): Promise | void; /** * Called after configuration has been loaded */ configResolved?(config: ResolvedFreshConfig): Promise | void; routes?: PluginRoute[]; middlewares?: PluginMiddleware[]; islands?: PluginIslands; } export interface PluginRenderContext { render: PluginRenderFunction; } export interface PluginAsyncRenderContext { renderAsync: PluginAsyncRenderFunction; } export interface PluginRenderResult { /** CSS styles to be injected into the page. */ styles?: PluginRenderStyleTag[]; /** JS scripts to ship to the client. */ scripts?: PluginRenderScripts[]; /** Link tags for the page */ links?: PluginRenderLink[]; /** Body HTML transformed by the plugin */ htmlText?: string; } export interface PluginRenderStyleTag { cssText: string; media?: string; id?: string; } export type PluginRenderLink = { crossOrigin?: string; href?: string; hreflang?: string; media?: string; referrerPolicy?: string; rel?: string; title?: string; type?: 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 type PluginAsyncRenderFunction = () => | PluginRenderFunctionResult | Promise; 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; } export interface PluginMiddleware> { /** A path in the format of a filename path without filetype */ path: string; middleware: Middleware; } export interface PluginRoute { /** A path in the format of a filename path without filetype */ path: string; component?: | ComponentType | ComponentType | AsyncRoute | AsyncLayout; // deno-lint-ignore no-explicit-any handler?: Handler | Handlers; } export interface PluginIslands { baseLocation: string; paths: string[]; } // --- Deprecated types --- /** * @deprecated This type was a short-lived alternative to `Handlers`. Please use `Handlers` instead. */ export type MultiHandler = Handlers; /** * @deprecated Use {@linkcode FreshConfig} instead */ export type StartOptions = FreshConfig; /** * @deprecated Use {@linkcode FreshConfig} interface instead. */ export type FreshOptions = FreshConfig; /** * @deprecated Use {@linkcode FreshContext} interface instead */ export type HandlerContext< Data = unknown, State = Record, NotFoundData = Data, > = FreshContext; /** * @deprecated Use {@linkcode FreshContext} interface instead */ // deno-lint-ignore no-explicit-any export type AppContext> = FreshContext< S, T >; /** * @deprecated Use {@linkcode FreshContext} interface instead */ // deno-lint-ignore no-explicit-any export type LayoutContext> = FreshContext< S, T >; /** * @deprecated Use {@linkcode FreshContext} interface instead */ export type UnknownHandlerContext> = FreshContext; /** * @deprecated Use {@linkcode FreshContext} interface instead */ export type ErrorHandlerContext> = FreshContext< State >; /** * @deprecated Use {@linkcode FreshContext} interface instead */ export type MiddlewareHandlerContext> = FreshContext; /** * @deprecated Use {@linkcode PageProps} instead */ // deno-lint-ignore no-explicit-any export type LayoutProps> = PageProps; /** * @deprecated Use {@linkcode PageProps} instead */ // deno-lint-ignore no-explicit-any export type UnknownPageProps> = PageProps< T, S >; /** * @deprecated Use {@linkcode PageProps} instead */ // deno-lint-ignore no-explicit-any export type AppProps> = PageProps; /** * @deprecated Use {@linkcode PageProps} instead */ export type ErrorPageProps = PageProps;