/// <reference types="node" />
import { JSONSchema4 } from 'json-schema';
import { ParsedPath } from 'path';
/** 请求方式 */
export declare enum Method {
    GET = "GET",
    POST = "POST",
    PUT = "PUT",
    DELETE = "DELETE",
    HEAD = "HEAD",
    OPTIONS = "OPTIONS",
    PATCH = "PATCH"
}
/** 是否必需 */
export declare enum Required {
    /** 不必需 */
    false = "0",
    /** 必需 */
    true = "1"
}
/** 请求数据类型 */
export declare enum RequestBodyType {
    /** 查询字符串 */
    query = "query",
    /** 表单 */
    form = "form",
    /** JSON */
    json = "json",
    /** 纯文本 */
    text = "text",
    /** 文件 */
    file = "file",
    /** 原始数据 */
    raw = "raw",
    /** 无请求数据 */
    none = "none"
}
/** 请求表单条目类型 */
export declare enum RequestFormItemType {
    /** 纯文本 */
    text = "text",
    /** 文件 */
    file = "file"
}
/** 返回数据类型 */
export declare enum ResponseBodyType {
    /** JSON */
    json = "json",
    /** 纯文本 */
    text = "text",
    /** XML */
    xml = "xml",
    /** 原始数据 */
    raw = "raw"
}
/** 接口定义 */
export interface Interface {
    /** 接口 ID */
    _id: number;
    /** 接口名称 */
    title: string;
    /** 接口备注 */
    markdown: string;
    /** 请求路径 */
    path: string;
    /** 请求方式，HEAD、OPTIONS 处理与 GET 相似，其余处理与 POST 相似 */
    method: Method;
    /** 所属分类 id */
    catid: number;
    /** 仅 GET：请求串 */
    req_query: Array<{
        /** 名称 */
        name: string;
        /** 备注 */
        desc: string;
        /** 示例 */
        example: string;
        /** 是否必需 */
        required: Required;
    }>;
    /** 仅 POST：请求内容类型。为 text, file, raw 时不必特殊处理。 */
    req_body_type: RequestBodyType;
    /** `req_body_type = json` 时是否为 json schema */
    req_body_is_json_schema: boolean;
    /** `req_body_type = form` 时的请求内容 */
    req_body_form: Array<{
        /** 名称 */
        name: string;
        /** 类型 */
        type: RequestFormItemType;
        /** 备注 */
        desc: string;
        /** 示例 */
        example: string;
        /** 是否必需 */
        required: Required;
    }>;
    /** `req_body_type = json` 时的请求内容 */
    req_body_other: string;
    /** 返回数据类型 */
    res_body_type: ResponseBodyType;
    /** `res_body_type = json` 时是否为 json schema */
    res_body_is_json_schema: boolean;
    /** 返回数据 */
    res_body: string;
    [key: string]: any;
}
/** 扩展接口定义 */
export interface ExtendedInterface extends Interface {
    parsedPath: ParsedPath;
}
/** 接口列表 */
export declare type InterfaceList = Interface[];
/** 分类信息 */
export interface Category {
    /** 分类名称 */
    name: string;
    /** 分类备注 */
    desc: string;
    /** 分类接口列表 */
    list: InterfaceList;
}
/** 分类列表，对应数据导出的 json 内容 */
export declare type CategoryList = Category[];
/**
 * 配置。
 */
export interface ServerConfig {
    /**
     * 构建ts 、js版本
     *
     * @example 'ts'
     */
    target: 'ts' | 'js';
    /**
     * YApi 服务地址。
     *
     * @example 'http://yapi.foo.bar'
     */
    serverUrl: string;
    /**
     * 项目id
     *
     * @example 'http://yapi.ywwl.org/project/24/interface/api' projectId 对应 24
     */
    projectId: string;
    /** cookie _yapi_token */
    _yapi_token: string;
    /** cookie _yapi_uid */
    _yapi_uid: string;
    /**
     * 是否自动开启changelog视图
     * generateUpdateJson 为 true时生效
     */
    changelog: boolean;
    /**
     * 1.1.0新增 是否生成 updateJson 文件, 默认 false
     */
    generateUpdateJson: boolean;
    /**
     * 1.1.0新增 是否生成 index 文件入口, 默认 false
     */
    generateIndexFile: boolean;
    /** api.d.ts 全局声明的命名空间 会包含所有的接口interface 默认值 YapiTypes */
    apiInterfaceNamespace?: string;
    /**
     * 输出文件路径。
     *
     * 可以是 `相对路径` 或 `绝对路径`。
     *
     * @example 'src/api/index.ts'
     */
    outputFilePath: string;
    /**
     * 1.1.0 被废除， 请使用customizeFilter
     * include 只包含的 catid
     * exclude 忽略的 catid
     * include exclude 只配置其中之一 也可以都不配置（*）
     */
    catid?: {
        exclude?: string[];
        include?: string[];
    };
    /**
     * 不校验git工作区
     */
    notCheckGit?: boolean;
    /**
     * prettier格式化
     */
    prettier?: object;
    /**
     * 过滤需要比对的文件方法
     * currentGitBranch 当前git分支号
     */
    customizeFilter?: (api: Omit<IOutPut, 'reqInterfaceName' | 'resInterfaceName' | 'requestInterface' | 'responseInterface'>, opt: {
        currentGitBranch: string;
    }) => boolean;
    /**
     * 文件名称生成规则
     * @param  {string} path 接口路径 url
     * @param  {string} _id 接口id
     * @param  {string} projectId 项目id
     */
    generateApiName?: (path: string, _id: string | number) => string;
    /**
     * 自定义代码片段函数
     * 不配置的话会有默认代码片段
     */
    generateApiFileCode?: (api: IOutPut) => string;
    /**
     * 更新文件方式
     * 1.1.0 废弃，请使用customizeFilter 自定义
     */
    updateMode?: ('ADD' | 'DELETE' | 'CHANGE')[];
}
export declare type Config = ServerConfig | ServerConfig[];
/**
 * 请求配置。
 */
export interface RequestConfig<MockUrl extends string = string, ProdUrl extends string = string, Path extends string = string, DataKey extends string | undefined = undefined> {
    /** 接口 Mock 地址，结尾无 `/` */
    mockUrl: MockUrl;
    /** 接口生产环境地址，结尾无 `/` */
    prodUrl: ProdUrl;
    /** 接口路径，以 `/` 开头 */
    path: Path;
    /** 请求方法 */
    method: Method;
    /** 请求数据类型 */
    requestBodyType: RequestBodyType;
    /** 返回数据类型 */
    responseBodyType: ResponseBodyType;
    /** 数据所在键 */
    dataKey: DataKey;
}
/**
 * 请求参数。
 */
export interface RequestFunctionParams extends RequestConfig {
    /** 请求数据，不含文件数据 */
    data: any;
    /** 请求文件数据 */
    fileData: Record<string, any>;
}
/**
 * 请求函数。
 *
 * 发起请求获得响应结果后应根据 `responseBodyType` 和 `dataKey` 对结果进行处理，并将处理后的数据返回。
 */
export declare type RequestFunction = (
/** 参数 */
params: RequestFunctionParams) => Promise<any>;
/** 属性定义 */
export interface PropDefinition {
    /** 属性名称 */
    name: string;
    /** 是否必需 */
    required: boolean;
    /** 类型 */
    type: JSONSchema4['type'];
    /** 注释 */
    comment: string;
}
/** 属性定义列表 */
export declare type PropDefinitions = PropDefinition[];
export interface ApiJsonItem {
    index: number;
    name: string;
    desc?: string;
    list: Interface[];
}
export declare type ApiJson = ApiJsonItem[];
export interface IOutPut {
    /** 生成api 文件名称 */
    name: string;
    /** 接口url */
    path: string;
    method: Method;
    /** 接口名 */
    title: string;
    /** 接口备注 */
    markdown: string;
    /** 分类菜单id */
    catid: number;
    /** 接口ID */
    id: number;
    reqInterfaceName: string;
    resInterfaceName: string;
    requestInterface: string;
    responseInterface: string;
    /**
     * yapi 基础数据源，包含yapi该项接口所有源数据
     */
    yapiBaseInfo: object;
}
export interface IFiles {
    [propName: string]: string;
}
export interface IUpdateJsonItem {
    time: Date;
    modifiedFiles: IFiles;
    addedFiles: IFiles;
    deletedFiles: IFiles;
}