yapi-to-typescript2 1.0.0

package/lib/esm/index.d.ts

@@ -0,0 +1,845 @@
+/// <reference types="node" />
+
+import type { AppendOptions } from 'form-data';
+import { JSONSchema4 } from 'json-schema';
+import { JSONSchema4TypeName } from 'json-schema';
+import { ParsedPath } from 'path';
+
+/** Useful as a return type in interfaces or abstract classes with missing implementation */
+declare type AsyncOrSync<T> = PromiseLike<T> | T;
+
+/** 分类信息 */
+export declare interface Category {
+    /** ID */
+    _id: number;
+    /** 分类在 YApi 上的地址（由 YTT 自行实现） */
+    _url: string;
+    /** 分类名称 */
+    name: string;
+    /** 分类备注 */
+    desc: string;
+    /** 分类接口列表 */
+    list: InterfaceList;
+    /** 创建时间（unix时间戳） */
+    add_time: number;
+    /** 更新时间（unix时间戳） */
+    up_time: number;
+}
+
+/**
+ * 分类的配置。
+ */
+export declare interface CategoryConfig extends SharedConfig {
+    /**
+     * 分类 ID，可以设置多个。设为 `0` 时表示全部分类。
+     *
+     * 如果需要获取全部分类，同时排除指定分类，可以这样：`[0, -20, -21]`，分类 ID 前面的负号表示排除。
+     *
+     * 获取方式：打开项目 --> 点开分类 --> 复制浏览器地址栏 `/api/cat_` 后面的数字。
+     *
+     * @example 20
+     */
+    id: number | number[];
+}
+
+/** 分类列表，对应数据导出的 json 内容 */
+export declare type CategoryList = Category[];
+
+export declare interface ChangeCase {
+    /**
+     * @example
+     * changeCase.camelCase('test string') // => 'testString'
+     */
+    camelCase: (value: string) => string;
+    /**
+     * @example
+     * changeCase.constantCase('test string') // => 'TEST_STRING'
+     */
+    constantCase: (value: string) => string;
+    /**
+     * @example
+     * changeCase.dotCase('test string') // => 'test.string'
+     */
+    dotCase: (value: string) => string;
+    /**
+     * @example
+     * changeCase.headerCase('test string') // => 'Test-String'
+     */
+    headerCase: (value: string) => string;
+    /**
+     * @example
+     * changeCase.lowerCase('TEST STRING') // => 'test string'
+     */
+    lowerCase: (value: string) => string;
+    /**
+     * @example
+     * changeCase.lowerCaseFirst('TEST') // => 'tEST'
+     */
+    lowerCaseFirst: (value: string) => string;
+    /**
+     * @example
+     * changeCase.paramCase('test string') // => 'test-string'
+     */
+    paramCase: (value: string) => string;
+    /**
+     * @example
+     * changeCase.pascalCase('test string') // => 'TestString'
+     */
+    pascalCase: (value: string) => string;
+    /**
+     * @example
+     * changeCase.pathCase('test string') // => 'test/string'
+     */
+    pathCase: (value: string) => string;
+    /**
+     * @example
+     * changeCase.sentenceCase('testString') // => 'Test string'
+     */
+    sentenceCase: (value: string) => string;
+    /**
+     * @example
+     * changeCase.snakeCase('test string') // => 'test_string'
+     */
+    snakeCase: (value: string) => string;
+    /**
+     * @example
+     * changeCase.swapCase('Test String') // => 'tEST sTRING'
+     */
+    swapCase: (value: string) => string;
+    /**
+     * @example
+     * changeCase.titleCase('a simple test') // => 'A Simple Test'
+     */
+    titleCase: (value: string) => string;
+    /**
+     * @example
+     * changeCase.upperCase('test string') // => 'TEST STRING'
+     */
+    upperCase: (value: string) => string;
+    /**
+     * @example
+     * changeCase.upperCaseFirst('test') // => 'Test'
+     */
+    upperCaseFirst: (value: string) => string;
+}
+
+/** 命令行钩子 */
+export declare interface CliHooks {
+    /** 生成成功时触发 */
+    success?: () => AsyncOrSync<void>;
+    /** 生成失败时触发 */
+    fail?: () => AsyncOrSync<void>;
+    /** 生成完毕时触发（无论成功、失败） */
+    complete?: () => AsyncOrSync<void>;
+}
+
+/** 支持生成注释的相关配置 */
+export declare interface CommentConfig {
+    /**
+     * 是否开启该项功能。
+     *
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * 是否有标题。
+     *
+     * @default true
+     */
+    title?: boolean;
+    /**
+     * 是否有分类名称。
+     *
+     * @default true
+     */
+    category?: boolean;
+    /**
+     * 是否有标签。
+     *
+     * @default true
+     */
+    tag?: boolean;
+    /**
+     * 是否有请求头。
+     *
+     * @default true
+     */
+    requestHeader?: boolean;
+    /**
+     * 是否有更新时间。
+     *
+     * @default true
+     */
+    updateTime?: boolean;
+    /**
+     * 是否为标题、分类名称添加链接。
+     *
+     * @default true
+     */
+    link?: boolean;
+    /**
+     * 额外的注释标签。生成的内容形如：`@{name} {value}`。
+     */
+    extraTags?: (interfaceInfo: ExtendedInterface) => Array<{
+        /**
+         * 标签名。
+         */
+        name: string;
+        /**
+         * 标签值。
+         */
+        value: string;
+        /**
+         * 标签位置，即将新标签插在标签列表的开头还是末尾。
+         *
+         * @default 'end'
+         */
+        position?: 'start' | 'end';
+    }>;
+}
+
+/** 配置。 */
+export declare type Config = ServerConfig | ServerConfig[];
+
+export declare type ConfigWithHooks = Config & {
+    hooks?: CliHooks;
+};
+
+/**
+ * 定义配置。
+ *
+ * @param config 配置
+ */
+export declare function defineConfig(config: Config, hooks?: CliHooks): ConfigWithHooks;
+
+/** 扩展接口定义 */
+export declare interface ExtendedInterface extends Interface {
+    parsedPath: ParsedPath;
+}
+
+export declare class FileData<T = any> {
+    /**
+     * 原始文件数据。
+     */
+    private originalFileData;
+    /**
+     * 选项。
+     */
+    private options;
+    /**
+     * 文件数据辅助类，统一网页、小程序等平台的文件上传。
+     *
+     * @param originalFileData 原始文件数据
+     * @param options 若使用内部的 getFormData，则选项会被其使用
+     */
+    constructor(originalFileData: T, options?: AppendOptions);
+    /**
+     * 获取原始文件数据。
+     *
+     * @returns 原始文件数据
+     */
+    getOriginalFileData(): T;
+    /**
+     * 获取选项。
+     */
+    getOptions(): AppendOptions | undefined;
+}
+
+/** 接口定义 */
+export declare interface Interface {
+    /** 接口 ID */
+    _id: number;
+    /** 所属分类信息（由 YTT 自行实现） */
+    _category: OmitStrict<Category, 'list'>;
+    /** 所属项目信息（由 YTT 自行实现） */
+    _project: Project;
+    /** 接口在 YApi 上的地址（由 YTT 自行实现） */
+    _url: string;
+    /** 接口名称 */
+    title: string;
+    /** 状态 */
+    status: LiteralUnion<'done' | 'undone', string>;
+    /** 接口备注 */
+    markdown: string;
+    /** 请求路径 */
+    path: string;
+    /** 请求方式，HEAD、OPTIONS 处理与 GET 相似，其余处理与 POST 相似 */
+    method: Method;
+    /** 所属项目 id */
+    project_id: number;
+    /** 所属分类 id */
+    catid: number;
+    /** 标签列表 */
+    tag: string[];
+    /** 请求头 */
+    req_headers: Array<{
+        /** 名称 */
+        name: string;
+        /** 值 */
+        value: string;
+        /** 备注 */
+        desc: string;
+        /** 示例 */
+        example: string;
+        /** 是否必需 */
+        required: Required_2;
+    }>;
+    /** 路径参数 */
+    req_params: Array<{
+        /** 名称 */
+        name: string;
+        /** 备注 */
+        desc: string;
+        /** 示例 */
+        example: string;
+        /** 类型（YApi-X） */
+        type?: RequestParamType;
+    }>;
+    /** 仅 GET：请求串 */
+    req_query: Array<{
+        /** 名称 */
+        name: string;
+        /** 备注 */
+        desc: string;
+        /** 示例 */
+        example: string;
+        /** 是否必需 */
+        required: Required_2;
+        /** 类型（YApi-X） */
+        type?: RequestQueryType;
+    }>;
+    /** 仅 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_2;
+    }>;
+    /** `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;
+    /** 创建时间（unix时间戳） */
+    add_time: number;
+    /** 更新时间（unix时间戳） */
+    up_time: number;
+    /** 创建人 ID */
+    uid: number;
+    [key: string]: any;
+}
+
+/** 接口列表 */
+export declare type InterfaceList = Interface[];
+
+/** 支持生成 JSON Schema 的相关配置 */
+export declare interface JsonSchemaConfig {
+    /**
+     * 是否开启该项功能。
+     */
+    enabled: boolean;
+    /**
+     * 是否生成请求数据的 JSON Schema。
+     *
+     * @default true
+     */
+    requestData?: boolean;
+    /**
+     * 是否生成返回数据的 JSON Schema。
+     *
+     * @default true
+     */
+    responseData?: boolean;
+}
+
+/**
+ Allows creating a union type by combining primitive types and literal types without sacrificing auto-completion in IDEs for the literal type part of the union.
+
+ Currently, when a union type of a primitive type is combined with literal types, TypeScript loses all information about the combined literals. Thus, when such type is used in an IDE with autocompletion, no suggestions are made for the declared literals.
+
+ This type is a workaround for [Microsoft/TypeScript#29729](https://github.com/Microsoft/TypeScript/issues/29729). It will be removed as soon as it's not needed anymore.
+
+ @example
+ ```
+ import {LiteralUnion} from 'type-fest';
+
+ // Before
+
+ type Pet = 'dog' | 'cat' | string;
+
+ const pet: Pet = '';
+ // Start typing in your TypeScript-enabled IDE.
+ // You **will not** get auto-completion for `dog` and `cat` literals.
+
+ // After
+
+ type Pet2 = LiteralUnion<'dog' | 'cat', string>;
+
+ const pet: Pet2 = '';
+ // You **will** get auto-completion for `dog` and `cat` literals.
+ ```
+
+ @category Utilities
+ */
+declare type LiteralUnion<
+	LiteralType,
+	BaseType extends Primitive,
+> = LiteralType | (BaseType & {_?: never});
+
+/** 请求方式 */
+export declare enum Method {
+    GET = "GET",
+    POST = "POST",
+    PUT = "PUT",
+    DELETE = "DELETE",
+    HEAD = "HEAD",
+    OPTIONS = "OPTIONS",
+    PATCH = "PATCH"
+}
+
+/** Similar to the builtin Omit, but checks the filter strictly. */
+declare type OmitStrict<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
+
+/**
+ * 同 `T | T[]`。
+ *
+ * @public
+ * @example
+ * ```typescript
+ * type X = OneOrMore<number> // => number | number[]
+ * ```
+ */
+declare type OneOrMore<T> = T | T[];
+
+/**
+ * 解析请求数据，从请求数据中分离出普通数据和文件数据。
+ *
+ * @param requestData 要解析的请求数据
+ * @returns 包含普通数据(data)和文件数据(fileData)的对象，data、fileData 为空对象时，表示没有此类数据
+ */
+export declare function parseRequestData(requestData?: any): {
+    data: any;
+    fileData: any;
+};
+
+/**
+ * 准备要传给请求函数的参数。
+ */
+export declare function prepare(requestConfig: RequestConfig, requestData: any): RequestFunctionParams;
+
+/**
+ Matches any [primitive value](https://developer.mozilla.org/en-US/docs/Glossary/Primitive).
+
+ @category Basic
+ */
+declare type Primitive =
+	| null
+	| undefined
+	| string
+	| number
+	| boolean
+	| symbol
+	| bigint;
+
+/** 项目信息 */
+export declare interface Project {
+    /** ID */
+    _id: number;
+    /** 项目在 YApi 上的地址（由 YTT 自行实现） */
+    _url: string;
+    /** 名称 */
+    name: string;
+    /** 描述 */
+    desc: string;
+    /** 基本路径 */
+    basepath: string;
+    /** 标签 */
+    tag: string[];
+    /** 环境配置 */
+    env: Array<{
+        /** 环境名称 */
+        name: string;
+        /** 环境域名 */
+        domain: string;
+    }>;
+}
+
+/**
+ * 项目的配置。
+ */
+export declare interface ProjectConfig extends SharedConfig {
+    /**
+     * 项目的唯一标识。支持多个项目。
+     *
+     * 获取方式：打开项目 --> `设置` --> `token配置` --> 复制 token。
+     *
+     * @example 'e02a47122259d0c1973a9ff81cabb30685d64abc72f39edaa1ac6b6a792a647d'
+     */
+    token: string | string[];
+    /**
+     * 分类列表。
+     */
+    categories: CategoryConfig[];
+}
+
+/** 属性定义 */
+export declare interface PropDefinition {
+    /** 属性名称 */
+    name: string;
+    /** 是否必需 */
+    required: boolean;
+    /** 类型 */
+    type: JSONSchema4['type'];
+    /** 注释 */
+    comment: string;
+}
+
+/** 属性定义列表 */
+export declare type PropDefinitions = PropDefinition[];
+
+/** 查询字符串数组格式化方式 */
+export declare enum QueryStringArrayFormat {
+    /** 示例: `a[]=b&a[]=c` */
+    'brackets' = "brackets",
+    /** 示例: `a[0]=b&a[1]=c` */
+    'indices' = "indices",
+    /** 示例: `a=b&a=c` */
+    'repeat' = "repeat",
+    /** 示例: `a=b,c` */
+    'comma' = "comma",
+    /** 示例: `a=["b","c"]` */
+    'json' = "json"
+}
+
+/** 支持生成 React Hooks 代码的相关配置 */
+export declare interface ReactHooksConfig {
+    /**
+     * 是否开启该项功能。
+     */
+    enabled: boolean;
+    /**
+     * 请求 Hook 函数制造者文件路径。
+     *
+     * @default 与 `outputFilePath` 同级目录下的 `makeRequestHook.ts` 文件
+     * @example 'src/api/makeRequestHook.ts'
+     */
+    requestHookMakerFilePath?: string;
+    /**
+     * 获取请求 Hook 的名称。
+     *
+     * @default `use${changeCase.pascalCase(requestFunctionName)}`
+     * @param interfaceInfo 接口信息
+     * @param changeCase 常用的大小写转换函数集合对象
+     * @returns 请求 Hook 的名称
+     */
+    getRequestHookName?(interfaceInfo: ExtendedInterface, changeCase: ChangeCase): string;
+}
+
+/** 请求数据类型 */
+export declare enum RequestBodyType {
+    /** 查询字符串 */
+    query = "query",
+    /** 表单 */
+    form = "form",
+    /** JSON */
+    json = "json",
+    /** 纯文本 */
+    text = "text",
+    /** 文件 */
+    file = "file",
+    /** 原始数据 */
+    raw = "raw",
+    /** 无请求数据 */
+    none = "none"
+}
+
+/**
+ * 请求配置。
+ */
+export declare interface RequestConfig<MockUrl extends string = string, DevUrl extends string = string, ProdUrl extends string = string, Path extends string = string, DataKey extends OneOrMore<string> | undefined = OneOrMore<string> | undefined, ParamName extends string = string, QueryName extends string = string, RequestDataOptional extends boolean = boolean> {
+    /** 接口 Mock 地址，结尾无 `/` */
+    mockUrl: MockUrl;
+    /** 接口测试环境地址，结尾无 `/` */
+    devUrl: DevUrl;
+    /** 接口生产环境地址，结尾无 `/` */
+    prodUrl: ProdUrl;
+    /** 接口路径，以 `/` 开头 */
+    path: Path;
+    /** 请求方法 */
+    method: Method;
+    /** 请求头，除了 Content-Type 的所有头 */
+    requestHeaders: Record<string, string>;
+    /** 请求数据类型 */
+    requestBodyType: RequestBodyType;
+    /** 返回数据类型 */
+    responseBodyType: ResponseBodyType;
+    /** 数据所在键 */
+    dataKey: DataKey;
+    /** 路径参数的名称列表 */
+    paramNames: ParamName[];
+    /** 查询参数的名称列表 */
+    queryNames: QueryName[];
+    /** 请求数据是否可选 */
+    requestDataOptional: RequestDataOptional;
+    /** 请求数据的 JSON Schema (仅开启了 JSON Schema 生成时生效) */
+    requestDataJsonSchema: JSONSchema4;
+    /** 返回数据的 JSON Schema (仅开启了 JSON Schema 生成时生效) */
+    responseDataJsonSchema: JSONSchema4;
+    /** 请求函数名称 */
+    requestFunctionName: string;
+    /** 如何格式化查询字符串中的数组值 */
+    queryStringArrayFormat: QueryStringArrayFormat;
+    /** 额外信息 */
+    extraInfo: Record<string, any>;
+}
+
+/** 请求表单条目类型 */
+export declare enum RequestFormItemType {
+    /** 纯文本 */
+    text = "text",
+    /** 文件 */
+    file = "file"
+}
+
+/**
+ * 请求参数。
+ */
+export declare interface RequestFunctionParams extends RequestConfig {
+    /** 原始数据 */
+    rawData: Record<string, any>;
+    /** 请求数据，不含文件数据 */
+    data: Record<string, any>;
+    /** 是否有文件数据 */
+    hasFileData: boolean;
+    /** 请求文件数据 */
+    fileData: Record<string, any>;
+    /** 所有请求数据，包括 data、fileData */
+    allData: Record<string, any>;
+    /** 获取全部请求数据（包含文件）的 FormData 实例 */
+    getFormData: () => FormData;
+}
+
+/** 请求函数的额外参数 */
+export declare type RequestFunctionRestArgs<T extends Function> = T extends (payload: any, ...args: infer R) => any ? R : never;
+
+/** 请求路径参数类型 */
+export declare enum RequestParamType {
+    /** 字符串 */
+    string = "string",
+    /** 数字 */
+    number = "number"
+}
+
+/** 请求查询参数类型 */
+export declare enum RequestQueryType {
+    /** 字符串 */
+    string = "string",
+    /** 数字 */
+    number = "number"
+}
+
+/** 是否必需 */
+declare enum Required_2 {
+    /** 不必需 */
+    false = "0",
+    /** 必需 */
+    true = "1"
+}
+export { Required_2 as Required }
+
+/** 返回数据类型 */
+export declare enum ResponseBodyType {
+    /** JSON */
+    json = "json",
+    /** 纯文本 */
+    text = "text",
+    /** XML */
+    xml = "xml",
+    /** 原始数据 */
+    raw = "raw"
+}
+
+/**
+ * 服务器的配置。
+ */
+export declare interface ServerConfig extends SharedConfig {
+    /**
+     * 服务地址。若服务类型为 `yapi`，此处填其首页地址；若服务类型为 `swagger`，此处填其 json 地址。
+     *
+     * @example 'http://yapi.foo.bar'
+     */
+    serverUrl: string;
+    /**
+     * 服务类型。
+     *
+     * @default 'yapi'
+     */
+    serverType?: 'yapi' | 'swagger';
+    /**
+     * 项目列表。
+     */
+    projects: ProjectConfig[];
+}
+
+/**
+ * 共享的配置。
+ */
+export declare interface SharedConfig {
+    /**
+     * 要生成的目标代码类型。
+     * 默认为 `typescript`，若设为 `javascript`，会将生成的 `.ts` 文件转换为 `.js` + `.d.ts` 文件并删除原 `.ts` 文件。
+     *
+     * @default 'typescript'
+     */
+    target?: 'typescript' | 'javascript';
+    /**
+     * 是否只生成接口请求内容和返回内容的 TypeSript 类型，是则请求文件和请求函数都不会生成。
+     *
+     * @default false
+     */
+    typesOnly?: boolean;
+    /**
+     * 测试环境名称。
+     *
+     * **用于获取测试环境域名。**
+     *
+     * 获取方式：打开项目 --> `设置` --> `环境配置` --> 点开或新增测试环境 --> 复制测试环境名称。
+     *
+     * @example 'dev'
+     */
+    devEnvName?: string;
+    /**
+     * 生产环境名称。
+     *
+     * **用于获取生产环境域名。**
+     *
+     * 获取方式：打开项目 --> `设置` --> `环境配置` --> 点开或新增生产环境 --> 复制生产环境名称。
+     *
+     * @example 'prod'
+     */
+    prodEnvName?: string;
+    /**
+     * 输出文件路径。
+     *
+     * 可以是 `相对路径` 或 `绝对路径`。
+     *
+     * @example 'src/api/index.ts'
+     */
+    outputFilePath?: string | ((interfaceInfo: Interface, changeCase: ChangeCase) => string);
+    /**
+     * 请求函数文件路径。
+     *
+     * @default 与 `outputFilePath` 同级目录下的 `request.ts` 文件
+     * @example 'src/api/request.ts'
+     */
+    requestFunctionFilePath?: string;
+    /**
+     * 如果接口响应的结果是 `JSON` 对象，
+     * 且我们想要的数据在该对象下，
+     * 那我们就可将 `dataKey` 设为我们想要的数据对应的键。
+     *
+     * 比如该对象为 `{ code: 0, msg: '成功', data: 100 }`，
+     * 我们想要的数据为 `100`，
+     * 则我们可将 `dataKey` 设为 `data`。
+     *
+     * @example 'data'
+     */
+    dataKey?: OneOrMore<string>;
+    /**
+     * 支持生成 React Hooks 代码的相关配置。
+     */
+    reactHooks?: ReactHooksConfig;
+    /**
+     * 支持生成 JSON Schema 的相关配置。
+     */
+    jsonSchema?: JsonSchemaConfig;
+    /**
+     * 支持生成注释的相关配置。
+     */
+    comment?: CommentConfig;
+    /**
+     * 将自定义类型转为 JSONSchema 类型的映射表，自定义类型名称大小写不敏感。
+     */
+    customTypeMapping?: Record<string, JSONSchema4TypeName>;
+    /**
+     * 如何格式化查询字符串中的数组值。
+     *
+     * @default QueryStringArrayFormat.brackets
+     */
+    queryStringArrayFormat?: QueryStringArrayFormat;
+    /**
+     * 设置传给请求函数的参数中的 extraInfo 的值。
+     *
+     * @param interfaceInfo 接口信息
+     * @param changeCase 常用的大小写转换函数集合对象
+     * @returns 返回要赋给 extraInfo 的值
+     */
+    setRequestFunctionExtraInfo?(interfaceInfo: Interface, changeCase: ChangeCase): Record<string, any>;
+    /**
+     * 预处理接口信息，返回新的接口信息。可返回 false 排除当前接口。
+     *
+     * 譬如你想对接口的 `path` 进行某些处理或者想排除某些接口，就可使用该方法。
+     *
+     * @param interfaceInfo 接口信息
+     * @param changeCase 常用的大小写转换函数集合对象
+     * @param syntheticalConfig 作用到当前接口的最终配置
+     * @example
+     *
+     * ```js
+     * interfaceInfo => {
+     *   interfaceInfo.path = interfaceInfo.path.replace('v1', 'v2')
+     *   return interfaceInfo
+     * }
+     * ```
+     */
+    preproccessInterface?(interfaceInfo: Interface, changeCase: ChangeCase, syntheticalConfig: SyntheticalConfig): Interface | false;
+    /**
+     * 获取请求函数的名称。
+     *
+     * @default changeCase.camelCase(interfaceInfo.parsedPath.name)
+     * @param interfaceInfo 接口信息
+     * @param changeCase 常用的大小写转换函数集合对象
+     * @returns 请求函数的名称
+     */
+    getRequestFunctionName?(interfaceInfo: ExtendedInterface, changeCase: ChangeCase): string;
+    /**
+     * 获取请求数据类型的名称。
+     *
+     * @default changeCase.pascalCase(`${requestFunctionName}Request`)
+     * @param interfaceInfo 接口信息
+     * @param changeCase 常用的大小写转换函数集合对象
+     * @returns 请求数据类型的名称
+     */
+    getRequestDataTypeName?(interfaceInfo: ExtendedInterface, changeCase: ChangeCase): string;
+    /**
+     * 获取响应数据类型的名称。
+     *
+     * @default changeCase.pascalCase(`${requestFunctionName}Response`)
+     * @param interfaceInfo 接口信息
+     * @param changeCase 常用的大小写转换函数集合对象
+     * @returns 响应数据类型的名称
+     */
+    getResponseDataTypeName?(interfaceInfo: ExtendedInterface, changeCase: ChangeCase): string;
+}
+
+/** 混合的配置。 */
+export declare type SyntheticalConfig = Partial<ServerConfig & ServerConfig['projects'][0] & ServerConfig['projects'][0]['categories'][0] & {
+    mockUrl: string;
+    devUrl: string;
+    prodUrl: string;
+}>;
+
+export { }