123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233
import type { AcceptedPlugin, bufio } from './deps.ts'
/** * The transform result of compiler. */export type TransformResult = {  code: string,  map?: string,  format?: 'js' | 'ts' | 'jsx' | 'tsx' | 'css',}
/** * A loader plugin to load source media. */export type LoaderPlugin = {  /** `type` specifies the plugin type. */  type: 'loader'  /** `test` matches the import url. */  test: RegExp  /** `acceptHMR` enables the HMR. */  acceptHMR?: boolean  /** `transform` transforms the source content. */  transform(content: Uint8Array, url: string): TransformResult | Promise<TransformResult>}
/** * A server plugin to enhance the aleph server application. */export type ServerPlugin = {  /** `type` specifies the plugin type. */  type: 'server'  /** `onInit` adds an `init` event to the server. */  onInit(app: ServerApplication): Promise<void> | void}
/** * A plugin for the aleph server application. */export type Plugin = LoaderPlugin | ServerPlugin
/** * The options for **SSR**. */export type SSROptions = {  /** A list of RegExp for paths to use **SSR**. */  include?: RegExp[]  /** A list of RegExp for paths to skip **SSR**. */  exclude?: RegExp[]  /** A list of paths for **dynamic routes** in **SSG**. */  staticPaths?: string[]}
/** * The config for the aleph server application. */export type Config = {  /** `framework` to run your application (default is 'react'). */  framework?: 'react'  /** `buildTarget` specifies the build target in production mode (default is **es5** to be compatible with IE11). */  buildTarget?: 'es5' | 'es2015' | 'es2016' | 'es2017' | 'es2018' | 'es2019' | 'es2020'  /** `srcDir` to put your application source code (default is '/'). */  srcDir?: string  /** `outputDir` specifies the output directory for `build` command (default is '**dist**'). */  outputDir?: string  /** `baseUrl` specifies the path prefix for the application (default is '/'). */  baseUrl?: string  /** `reactVersion` specifies the **react version** (default is '17.0.1'). */  reactVersion?: string  /** `defaultLocale` specifies the default locale of the application (default is '**en**'). */  defaultLocale?: string  /** A list of locales. */  locales?: string[]  /** The options for **SSR**. */  ssr?: boolean | SSROptions  /** A list of plugin. */  plugins?: Plugin[]  /** A list of plugin of PostCSS. */  postcss?: { plugins: (string | AcceptedPlugin | [string | ((options: Record<string, any>) => AcceptedPlugin), Record<string, any>])[] }  /** `env` appends env variables (use `Deno.env.get(key)` to get an env variable). */  env?: Record<string, string>}
/** * An interface that aligns to the parts of the aleph server's `Application`. */interface ServerApplication {  readonly workingDir: string  readonly mode: 'development' | 'production'  addPageModule(pathname: string, code: string): Promise<void>  removePageModule(pathname: string): Promise<void>}
/** * An interface that aligns to the parts of std http srever's `ServerRequest`. */export interface ServerRequest {  readonly url: string  readonly method: string  readonly headers: Headers  readonly conn: Deno.Conn  readonly r: bufio.BufReader  readonly w: bufio.BufWriter  readonly body: Deno.Reader  respond(r: ServerResponse): Promise<void>}
/** * An interface is compatible with std http srever's `request.respond()`. */export interface ServerResponse {  status?: number  headers?: Headers  body?: Uint8Array | Deno.Reader | string}
/** * An interface extends the `ServerRequest` for API requests. */export interface APIRequest extends ServerRequest {  readonly pathname: string  readonly params: Record<string, string>  readonly query: URLSearchParams  readonly cookies: ReadonlyMap<string, string>  /** `status` sets response status of the request. */  status(code: number): this  /**   * `addHeader` adds a new value onto an existing response header of the request, or   * adds the header if it does not already exist.   */  addHeader(key: string, value: string): this  /**   * `setHeader` sets a new value for an existing response header of the request, or adds   * the header if it does not already exist.   */  setHeader(key: string, value: string): this  /** `removeHeader` removes the value for an existing response header of the request. */  removeHeader(key: string): this  /** `send` replies to the request with any content with type. */  send(data: string | Uint8Array | ArrayBuffer, contentType?: string): Promise<void>  /** `json` replies to the request with a json content. */  json(data: any): Promise<void>  /** `decodeBody` will return a string, form-data, or json object. */  decodeBody(type: 'form-data'): Promise<FormDataBody>  decodeBody(type: 'text'): Promise<string>  decodeBody(type: 'json'): Promise<any>}
/** * A handler to handle api requests. * * @param req APIRequest object */export type APIHandler = {  (req: APIRequest): void}
/** * The router url object of the routing, you can access it with `useRouter()` hook. */export type RouterURL = {  readonly locale: string  readonly pathname: string  readonly pagePath: string  readonly params: Record<string, string>  readonly query: URLSearchParams}
/** * A module includes compilation details. */export type Module = {  url: string  loader: string  sourceHash: string  hash: string  deps: DependencyDescriptor[]  jsFile: string  bundlingFile: string  error: Error | null}
/** * The dependency descriptor. */export type DependencyDescriptor = {  url: string  hash: string  isDynamic?: boolean  isStyle?: boolean  isData?: boolean}
/** * The render result of SSR. */export type RenderResult = {  url: RouterURL  status: number  head: string[]  body: string  scripts: Record<string, any>[]  data: Record<string, string> | null}
/** * The form data body. */export type FormDataBody = {  fields: Record<string, string>  files: FormFile[]  get(key: string): string | undefined  getFile(key: string): FormFile | undefined}
/** * The form file. */export type FormFile = {  name: string  content: Uint8Array  contentType: string  filename: string  size: number}
/** * The ES Import maps. */export type ImportMap = {  imports: Record<string, string>,  scopes: Record<string, Record<string, string>>}