f2e-server/index.d.ts

import { IncomingMessage, ServerResponse, Server } from "http"
import { MemoryTree } from "memory-tree"
import * as babel from 'babel-core'
import * as net from 'net'
type LessConfig = Less.Options
interface BabelConfig extends babel.TransformOptions {
    /**
     * 哪些后缀需要babel编译
     * @default /\.[jet]sx?$/
     */
    _suffix?: RegExp
}

declare function f2eserver(conf: f2eserver.F2EConfig): void
declare namespace f2eserver {
    export type SetResult = MemoryTree.DataBuffer | {
        data: MemoryTree.DataBuffer;
        outputPath?: string;
        originPath?: string;
    }
    export interface F2Events {
        /**
         *  on request begin
         */
        beforeRoute?: {
            (pathname: string, req: IncomingMessage, resp: ServerResponse, mem?: MemoryTree.Store): string | false | undefined
        }
        /**
         * on request end
         */
        onRoute?: {
            (pathname: string, req: IncomingMessage, resp: ServerResponse, mem: MemoryTree.Store): string | false | undefined
        }
        /**
         * on file change
         */
        buildWatcher?: {
            (pathname: string, eventType: string, build: MemoryTree.Build, store: MemoryTree.Store): void
        }
        /**
         * on data save into memory
         */
        onSet?: {
            (pathname: string, data: MemoryTree.DataBuffer, store: MemoryTree.Store): SetResult | Promise<SetResult>
        }
        /**
         * get data from memory
         */
        onGet?: {
            (pathname: string, data: MemoryTree.DataBuffer, store: MemoryTree.Store): MemoryTree.DataBuffer | Promise<MemoryTree.DataBuffer>
        }
        /**
         * if text
         */
        onText?: {
            (pathname: string, data: MemoryTree.DataBuffer, req: IncomingMessage, resp: ServerResponse, mem: MemoryTree.Store): MemoryTree.DataBuffer | false
        }
        /**
         * whether to build some path from disk
         */
        buildFilter?: {
            (pathname: string): boolean
        }
        /**
         * whether to persist data by outputPath
         */
        outputFilter?: {
            (pathname: string, data: MemoryTree.DataBuffer): boolean
        }
    }
    export interface Middleware extends F2Events {
        /**
         * turn of middle to execute
         */
        setBefore?: number
    }
    export interface MiddlewareCreater {
        (conf: F2EConfig): Middleware
    }
    export interface MiddlewareRef {
        /**
         * middleware name
         * > if you middleware named `f2e-middle-markdown` then use 'markdown' here
         * > ## middleware should implements MiddlewareCreater
         */
        middleware: string
        /**
         * turn of middle to execute
         */
        setBefore?: number
        /**
         * support muti options for any middlewares
         */
        [x: string]: any
    }

    export interface PageRender<T = any, R = string> {
        (req: IncomingMessage, resp: ServerResponse, data: T): R
    }

    export interface F2EConfig extends F2Events {
        root?: string
        port?: number
        host?: string
        /**
         * no host valid
         */
        no_host?: boolean
        livereload?: boolean
        build?: boolean
        gzip?: boolean
        /**
         * stream data output size per response
         */
        range_size?: number
        useLess?: boolean | LessConfig
        useBabel?: boolean | BabelConfig
        /**
         * 启用babel时候是否
         */
        sourceMap?: boolean

        /**
         * 简单打包模式, 会把依赖的文件无序的合并到目标文件中
         * 不支持sourcemap
         */
        bundles?: {
            /** 用一个正则匹配到所有需要合并的文件列表 */
            test?: RegExp
            /** 目标文件完整路径, 必须在项目中存在 */
            dist?: string
        }[]

        /**
         * 使用 bundles 模式打包amd模块时，支持根据文件路径设置 模块ID
         */
        getModuleId?: (pathname: string) => string

        /**
         * @default /\$include\[["'\s]*([^"'\s]+)["'\s]*\](?:\[["'\s]*([^"'\s]+)["'\s]*\])?/g
         */
        include?: RegExp
        /**
         * @default /\$belong\[["'\s]*([^"'\s]+)["'\s]*\]/
         */
        belong?: RegExp
        /**
         * @default "$[placeholder]"
         */
        placeholder?: string

        /**
         * 通过文件名判断是否文本资源, 用于include模块扩展mime
         */
        isText?: (pathname: string) => boolean

        middlewares?: (MiddlewareCreater | MiddlewareRef)[]
        output?: string
        /**
         * build 阶段是否使用 uglify/cleanCSS 进行 minify 操作
         * 可以根据文件路径或者文件内容、大小给出结果
         * @param  {string} pathname 资源路径名
         * @param  {MemoryTree.DataBuffer} data     资源内容
         * @return {boolean}
         */
        shouldUseMinify?: (pathname: string, data: MemoryTree.DataBuffer) => boolean
        /**
         * after server create
         * you can render websocket server via this
         */
        onServerCreate?: (server: net.Server) => void
        /**
         * init urls on server start
         */
        init_urls?: string[]

        /**
         * pages config
         */
        page_404?: string | PageRender<{ pathname: string }>
        page_50x?: string | PageRender<{ error: Error }>
        page_dir?: string | PageRender<{ pathname: string, store: Object, conf: F2EConfig }>

        /**
         * 提供验证账户密码, 文件上传、删除等操作需要
         */
        authorization?: string
    }
}
export = f2eserver;