Module

x/aleph/server/types.ts

The Full-stack Framework in Deno.
Go to Latest
File
import type { ConnInfo, ServeInit } from "https://deno.land/std@0.155.0/http/server.ts";import type { Comment, Element, TextChunk } from "https://deno.land/x/lol_html@0.0.4/types.d.ts";import type { UserConfig } from "https://esm.sh/@unocss/core@0.45.14";import type { RouteModule } from "../runtime/core/route.ts";export type { Route, RouteMatch, RouteMeta, Router, RouteRegExp } from "../runtime/core/route.ts";export type { Comment, ConnInfo, Element, RouteModule, ServeInit, TextChunk };
export type AlephConfig = { /** The base url of the server. */ baseUrl?: string; /** The router options for the file-system based routing. */ router?: RouterInit; /** The module loaders. */ loaders?: ModuleLoader[]; /** The server middlewares. */ middlewares?: Middleware[]; /** The options for session. */ session?: SessionOptions; /** The options for SSR. */ ssr?: SSR; /** The options for optimization. */ optimization?: OptimizationOptions; /** The config for UnoCSS. */ unocss?: UnoConfig;};
/** The router options for the file-system based routing. */export interface RouterInit { /** The glob to match routes. */ glob?: string; /** The directory of the FS routing. Default is './routes' */ dir?: string; /** The extnames to match routes. */ exts?: string[]; /** The pre-built routes. */ routes?: Record<string, Record<string, unknown>>;}
/** The config for UnoCSS. */export type UnoConfig = UserConfig & { test?: RegExp; resetCSS?: "normalize" | "eric-meyer" | "tailwind" | "antfu";};
export type CookieOptions = { expires?: number | Date; maxAge?: number; domain?: string; path?: string; httpOnly?: boolean; secure?: boolean; sameSite?: "lax" | "strict" | "none";};
export interface Cookies { get(key: string): string | undefined; set(key: string, value: string, options?: CookieOptions): void; delete(key: string, options?: CookieOptions): void;}
export interface SessionStorage { get(sid: string): Promise<Record<string, unknown> | undefined>; set(sid: string, data: Record<string, unknown>, expires: number): Promise<void>; delete(sid: string): Promise<void>;}
export type SessionCookieOptions = { name?: string; domain?: string; path?: string; secure?: boolean; sameSite?: "lax" | "strict" | "none";};
export type SessionOptions = { storage?: SessionStorage; cookie?: SessionCookieOptions; secret?: string; maxAge?: number;};
export interface Session<T> { store: T | undefined; update(store: T | ((store: T | undefined) => T), redirectTo: string): Promise<Response>; end(redirectTo: string): Promise<Response>;}
export interface HTMLRewriterHandlers { element?: (element: Element) => void; comments?: (comment: Comment) => void; text?: (text: TextChunk) => void;}
export interface HTMLRewriter { on: (selector: string, handlers: HTMLRewriterHandlers) => void;}
export interface Context extends Record<string, unknown> { /** The request connection info. */ readonly connInfo?: ConnInfo; /** The params of dynamic routes. */ readonly params: Record<string, string>; /** The headers for final response. */ readonly headers: Headers; /** The cookies from client. */ readonly cookies: Cookies; /** The HtmlRewriter to rewrite the html output. */ readonly htmlRewriter: HTMLRewriter; /** Returns the `Session` object. */ getSession< T extends Record<string, unknown> = Record<string, unknown>, >(): Promise<Session<T>>;}
/** The Middleare for Aleph server. */export interface Middleware { /** The middleware name. */ readonly name?: string; /** The middleware fetch method. */ fetch( request: Request, context: Context, ): Promise<Response | (() => void) | void> | Response | (() => void) | void;}
export type ImportMap = { readonly __filename: string; readonly imports: Record<string, string>; readonly scopes: Record<string, Record<string, string>>;};
export type JSXConfig = { jsxPragma?: string; jsxPragmaFrag?: string; jsxImportSource?: string;};
export type ModuleLoaderEnv = { isDev?: boolean; importMap?: ImportMap; jsxConfig?: JSXConfig; sourceMap?: boolean; spaMode?: boolean; ssr?: boolean;};
export type ModuleLoaderOutput = { code: string; inlineCSS?: string; lang?: "js" | "jsx" | "ts" | "tsx"; map?: string;};
export interface ModuleLoader { test(path: string): boolean; load( specifier: string, content: string, env: ModuleLoaderEnv, ): Promise<ModuleLoaderOutput> | ModuleLoaderOutput;}
/** The optimization options for the server. */export type OptimizationOptions = { /** The output directory, default is "./out". */ outputDir?: string; /** The built target for esbuild, default is "es2018". */ buildTarget?: "es2015" | "es2016" | "es2017" | "es2018" | "es2019" | "es2020" | "es2021" | "es2022"; /** The SSG options for the FS routing. */ ssg?: boolean | SSGOptions;};
/** The SSG options for the FS routing. */export type SSGOptions = { include?: RegExp; exclude?: RegExp; getStaticPaths?: () => string[] | Promise<string[]>; clientHeaders?: HeadersInit;};
export type SSRContext = { readonly url: URL; readonly routing: RouteModule[]; readonly headCollection: string[]; readonly signal: AbortSignal; readonly nonce?: string; setStatus(code: number): void; setSuspenseMark(selector: string, test: (el: Element) => boolean): void;};
export type SuspenseMark = { selector: string; test: (el: Element) => boolean;};
export type SSRFn = { (ssr: SSRContext): Promise<ReadableStream | string> | ReadableStream | string;};
/** * Options for the content-security-policy. * https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy */export type CSP = { nonce?: boolean; getPolicy: (url: URL, nonce?: string) => string | null;};
export type SSROptions = { CSP?: CSP;};
export type SSR = | SSRFn | SSROptions & { render: SSRFn; };
export type ErrorHandler = { ( error: unknown, cause: "route-data-fetch" | "ssr" | "transform" | "fs" | "middleware", request: Request, context: Context, ): Response | void;};