open-api-typescript-request-generator 0.0.1-alpha.2 → 0.0.2

package/lib/helpers.js

@@ -186,13 +186,7 @@ function defineConfig(config) {
   var final = configs.map(function (item) {
     return __assign({
       serverUrl: '',
-      typesOnly: false,
-      target: 'typescript',
-      outputFilePath: 'src/api',
-      dataKey: 'data',
-      jsonSchema: {
-        enabled: false
-      }
+      outputFilePath: 'src/api'
     }, item);
   });
   return final;

package/lib/responseDataJsonSchemaHandler.js

@@ -187,7 +187,7 @@ var runner = function runner(path, data, jsonSchema) {
 exports.runner = runner;
 
 var jsonSchemeFileHeader = function jsonSchemeFileHeader() {
-  return "\n  import * as changeCase from 'change-case';\n  import { JSONSchema4 } from 'api-ts-generator';\n\n  /**\n   * \u83B7\u53D6scheme\u7684key\n   */\n  export const jsonSchemeKey = function (path: string): string {\n    const deeps = path.split('/');\n    const names = deeps.splice(deeps.length - 4, deeps.length).join('_');\n    return changeCase.camelCase(names);\n  };\n\n  export const typeStr = function (data: unknown): string {\n    const type = typeof data;\n    if (type === 'object' && data instanceof Array) {\n      return 'array';\n    }\n    if (type === 'object' && data === null) {\n      return 'null';\n    }\n    if (type === 'number') {\n      return 'integer';\n    }\n\n    return type;\n  };\n\n  /**\n   * \u68C0\u67E5\u5668\n   */\n  export const responseDataInspector = function (data: any, jsonScheme: JSONSchema4, key: any[] = ['data']): boolean {\n    const { type, properties, items } = jsonScheme;\n\n    if (type !== typeStr(data)) {\n      console.warn(`->ResponseDataInspector\uFF1A${key.join('.')}\u4E0E\u7EA6\u5B9A\u7684\u7C7B\u578B\u4E0D\u7B26\uFF0C\u7C7B\u578B\uFF1A${type}\uFF0C\u8FD4\u56DE\u503C\uFF1A${data}`);\n      return false;\n    }\n    if (type === 'object') {\n      if (!properties || !Object.keys(properties).length) {\n        return true;\n      }\n      return Object.keys(properties).every(k => responseDataInspector(data[k], properties[k], [...key, k]));\n    }\n    if (type === 'array') {\n      if (items === undefined) {\n        // undefined\u5219\u4E3A\u63A5\u53D7\u4EFB\u610F\u7C7B\u578B\n        return true;\n      }\n      if (items instanceof Array) {\n        return (data as Array<any>).some(v => items.every(item => responseDataInspector(v, item)));\n      }\n      if (items instanceof Object) {\n        return (data as Array<any>).every((v, index) => responseDataInspector(v, items, [...key, index]));\n      }\n    }\n\n    return true;\n  };\n\n  export const runner = function (path: string, data: any, jsonSchema: Record<string, any>): void {\n    const key = jsonSchemeKey(path);\n    responseDataInspector(data, jsonSchema[key]);\n  };\n  ";
+  return "\n  import * as changeCase from 'change-case';\n  import { JSONSchema4 } from 'open-api-typescript-request-generator';\n\n  /**\n   * \u83B7\u53D6scheme\u7684key\n   */\n  export const jsonSchemeKey = function (path: string): string {\n    const deeps = path.split('/');\n    const names = deeps.splice(deeps.length - 4, deeps.length).join('_');\n    return changeCase.camelCase(names);\n  };\n\n  export const typeStr = function (data: unknown): string {\n    const type = typeof data;\n    if (type === 'object' && data instanceof Array) {\n      return 'array';\n    }\n    if (type === 'object' && data === null) {\n      return 'null';\n    }\n    if (type === 'number') {\n      return 'integer';\n    }\n\n    return type;\n  };\n\n  /**\n   * \u68C0\u67E5\u5668\n   */\n  export const responseDataInspector = function (data: any, jsonScheme: JSONSchema4, key: any[] = ['data']): boolean {\n    const { type, properties, items } = jsonScheme;\n\n    if (type !== typeStr(data)) {\n      console.warn(`->ResponseDataInspector\uFF1A${key.join('.')}\u4E0E\u7EA6\u5B9A\u7684\u7C7B\u578B\u4E0D\u7B26\uFF0C\u7C7B\u578B\uFF1A${type}\uFF0C\u8FD4\u56DE\u503C\uFF1A${data}`);\n      return false;\n    }\n    if (type === 'object') {\n      if (!properties || !Object.keys(properties).length) {\n        return true;\n      }\n      return Object.keys(properties).every(k => responseDataInspector(data[k], properties[k], [...key, k]));\n    }\n    if (type === 'array') {\n      if (items === undefined) {\n        // undefined\u5219\u4E3A\u63A5\u53D7\u4EFB\u610F\u7C7B\u578B\n        return true;\n      }\n      if (items instanceof Array) {\n        return (data as Array<any>).some(v => items.every(item => responseDataInspector(v, item)));\n      }\n      if (items instanceof Object) {\n        return (data as Array<any>).every((v, index) => responseDataInspector(v, items, [...key, index]));\n      }\n    }\n\n    return true;\n  };\n\n  export const runner = function (path: string, data: any, jsonSchema: Record<string, any>): void {\n    const key = jsonSchemeKey(path);\n    responseDataInspector(data, jsonSchema[key]);\n  };\n  ";
 };
 
 exports.jsonSchemeFileHeader = jsonSchemeFileHeader;

package/lib/types.d.ts

@@ -7,11 +7,7 @@ import { ParsedPath } from 'path';
 export declare type requestFunctionTemplateType = (props: RequestFunctionTemplateProps, config?: SyntheticalConfig) => string;
 /** 顶部依赖生成模板函数 */
 /** 生成器参数 */
-export declare type topImportPkgTemplateType = () => string;
-export interface GenTemplateType {
-    requestFunctionTemplate?: requestFunctionTemplateType;
-    topImportPkgTemplate?: topImportPkgTemplateType;
-}
+export declare type topImportTemplateType = () => string;
 export interface GeneratorOptions {
     cwd: string;
 }
@@ -314,29 +310,6 @@ export interface ExtendedInterface extends Interface {
 }
 /** 分类列表，对应数据导出的 json 内容 */
 export declare type CategoryList = Category[];
-/** 支持生成 React Hooks 代码的相关配置 */
-export 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;
-}
 /** 支持生成 JSON Schema 的相关配置 */
 export interface JsonSchemaConfig {
     /**
@@ -393,29 +366,6 @@ export interface CommentConfig {
  * 共享的配置。
  */
 export interface SharedConfig {
-    /**
-     * 要生成的目标代码类型。
-     * 默认为 `typescript`，若设为 `javascript`，会将生成的 `.ts` 文件转换为 `.js` + `.d.ts` 文件并删除原 `.ts` 文件。
-     *
-     * @default 'typescript'
-     */
-    target?: 'typescript' | 'javascript';
-    /**
-     * 是否只生成接口请求内容和返回内容的 TypeSript 类型，是则请求文件和请求函数都不会生成。
-     *
-     * @default false
-     */
-    typesOnly?: boolean;
-    /**
-     * 测试环境名称。
-     *
-     * **用于获取测试环境域名。**
-     *
-     * 获取方式：打开项目 --> `设置` --> `环境配置` --> 点开或新增测试环境 --> 复制测试环境名称。
-     *
-     * @example 'dev'
-     */
-    devEnvName?: string;
     /**
      * 输出文件路径。
      *
@@ -431,22 +381,6 @@ export interface SharedConfig {
      * @example 'src/api/request.ts'
      */
     requestFunctionFilePath?: string;
-    /**
-     * 如果接口响应的结果是 `JSON` 对象，
-     * 且我们想要的数据在该对象下，
-     * 那我们就可将 `dataKey` 设为我们想要的数据对应的键。
-     *
-     * 比如该对象为 `{ code: 0, msg: '成功', data: 100 }`，
-     * 我们想要的数据为 `100`，
-     * 则我们可将 `dataKey` 设为 `data`。
-     *
-     * @example 'data'
-     */
-    dataKey?: string;
-    /**
-     * 支持生成 React Hooks 代码的相关配置。
-     */
-    reactHooks?: ReactHooksConfig;
     /**
      * 支持生成 JSON Schema 的相关配置。
      */
@@ -454,21 +388,6 @@ export interface SharedConfig {
      * 支持生成注释的相关配置。
      */
     comment?: CommentConfig;
-    /**
-     * 预处理接口信息，返回新的接口信息。可返回 false 排除当前接口。
-     *
-     * 譬如你想对接口的 `path` 进行某些处理或者想排除某些接口，就可使用该方法。
-     *
-     * @example
-     *
-     * ```js
-     * interfaceInfo => {
-     *   interfaceInfo.path = interfaceInfo.path.replace('v1', 'v2')
-     *   return interfaceInfo
-     * }
-     * ```
-     */
-    preproccessInterface?(interfaceInfo: Interface, changeCase: ChangeCase): Interface | false;
     /**
      * 获取请求函数的名称。
      *
@@ -497,116 +416,26 @@ export interface SharedConfig {
      */
     getResponseDataTypeName?(interfaceInfo: ExtendedInterface, changeCase: ChangeCase): string;
 }
-/**
- * 分类的配置。
- */
-export interface CategoryConfig extends SharedConfig {
-    /**
-     * 分类 ID。
-     *
-     * 获取方式：打开项目 --> 点开分类 --> 复制浏览器地址栏 `/api/cat_` 后面的数字。
-     *
-     * @example 20
-     */
-    id: number;
-    /**
-     * 过滤接口
-     */
-    filter?: ((path: string, id?: number) => boolean) | RegExp | string[];
-}
-export interface TokenNeed {
-    /**
-     * 项目id，与token等效，二选一
-     *
-     * 获取方式：打开项目 --> `设置` --> `项目配置` --> 项目ID。
-     *
-     * @example '123'
-     */
-    projectId?: number;
-    /**
-     * 项目的token，与projectId等效，二选一
-     *
-     * 获取方式：打开项目 --> `设置` --> `token配置` --> 复制 token。
-     *
-     * @example 'e02a47122259d0c1973a9ff81cabb30685d64abc72f39edaa1ac6b6a792a647d'
-     */
-    token: string;
-}
-export interface ProjectIdNeed {
-    /**
-     * 项目id，与token等效，二选一
-     *
-     * 获取方式：打开项目 --> `设置` --> `项目配置` --> 项目ID。
-     *
-     * @example '123'
-     */
-    projectId: number;
-    /**
-     * 项目的token，与projectId等效，二选一
-     *
-     * 获取方式：打开项目 --> `设置` --> `token配置` --> 复制 token。
-     *
-     * @example 'e02a47122259d0c1973a9ff81cabb30685d64abc72f39edaa1ac6b6a792a647d'
-     */
-    token?: string;
-}
-/**
- * 项目的配置。
- */
-export declare type ProjectConfig = SharedConfig & (ProjectIdNeed | TokenNeed) & {
-    /**
-   * 设置接口的baseURL
-   *
-   * @description 若要配置使用运行时代码，则增加`[code]:`前缀
-   ```
-   例：
-    baseURL: "[code]:process.env.BASE_URL"  => baseURL:process.env.BASE_URL
-
-    baseURL: "process.env.BASE_URL" => baseURL:"process.env.BASE_URL"
-   ```
-   */
-    baseURL?: ((path: string) => string | undefined) | string;
-    /**
-     * 分类列表。
-     */
-    categories?: CategoryConfig[];
-};
 /**
  * 服务器的配置。
  */
-export interface ServerConfig extends SharedConfig, GenTemplateType {
-    name?: string;
+export interface ApiConfig {
+    name: string;
     configIndex?: number;
     /**
-     * 服务地址。若服务类型为 `yapi`，此处填其首页地址；若服务类型为 `swagger`，此处填其 json 地址。
+     * 服务地址。此处填其 swagger json 地址。
+     * 比如nestjs项目一般为http://localhost:3041/api-json
      *
      */
     serverUrl: string;
     /**
-     * 项目列表。
-     */
-    project?: ProjectConfig;
-    /**
-     * prettier代码格式化配置文件的路径
+     * 输出文件路径。
      *
-     * @default process.cwd()
-     */
-    prettierConfigPath?: string;
-    /**
-     * 是否使用默认请求库，关闭后不再生成request.ts
-     */
-    defaultRequestLib?: boolean;
-    /**
-     * 代理请求模式，所有请求均请求到指定接口
+     * 可以是 `相对路径` 或 `绝对路径`。
+     *
+     * @example 'src/api/index.ts'
      */
-    proxyInterface?: {
-        /**
-         * 代理接口
-         *
-         * @default /admin-interface/proxy/v0/proxy
-         */
-        path?: string;
-    };
+    outputFilePath?: string;
     /**
      * 设置接口的baseURL
      *
@@ -615,50 +444,31 @@ export interface ServerConfig extends SharedConfig, GenTemplateType {
      例：
       baseURL: "[code]:process.env.BASE_URL"  => baseURL:process.env.BASE_URL
   
-      baseURL: "process.env.BASE_URL" => baseURL:"process.env.BASE_URL"
+      baseURL: "http://localhost:3000" => baseURL:"http://localhost:3000"
      ```
      */
     baseURL?: ((path: string) => string | undefined) | string;
     /**
-     * 过滤接口
+     * 在每个生成的api文件顶部定义一段代码
+     * 例如：引入自定义request函数
+     * default: import request from './request'
      */
-    filter?: ((path: string, id?: number) => boolean) | RegExp | string[];
+    topImportTemplate?: topImportTemplateType;
     /**
-     * yapi页面链接地址列表
-     * 通过url分析出项目id，接口id，分类id
-     *
-     @example
-     ```
-      `/project/9/interface/api/43 => 项目id:9、接口id: 43`
-     ```
-     */
-    yapiUrlList?: string | string[];
-    /**
-     * 请求函数是否需要extra入参
-     *
-     * @default false
+     * 是否使用默认请求库，关闭后不再生成request.ts
      */
-    requestFunctionExtraParams?: boolean;
+    defaultRequestLib?: boolean;
 }
 /** 混合的配置。 */
-export declare type SyntheticalConfig = Partial<ServerConfig & ProjectConfig & CategoryConfig & {
-    mockUrl: string;
-    devUrl: string;
-    prodUrl: string;
+export declare type SyntheticalConfig = Partial<ApiConfig & {
     components: OpenAPIV3.Document['components'];
 }>;
 /** 配置。 */
-export declare type Config = ServerConfig;
+export declare type Config = ApiConfig;
 /**
  * 请求配置。
  */
-export interface RequestConfig<MockUrl extends string = string, DevUrl extends string = string, ProdUrl extends string = string, Path extends string = string, DataKey extends string | undefined = string | undefined, ParamName extends string = string, QueryName extends string = string, RequestDataOptional extends boolean = boolean> {
-    /** 接口 Mock 地址，结尾无 `/` */
-    mockUrl: MockUrl;
-    /** 接口测试环境地址，结尾无 `/` */
-    devUrl: DevUrl;
-    /** 接口生产环境地址，结尾无 `/` */
-    prodUrl: ProdUrl;
+export interface RequestConfig<Path extends string = string, ParamName extends string = string, QueryName extends string = string, RequestDataOptional extends boolean = boolean> {
     /** 接口路径，以 `/` 开头 */
     path: Path;
     /** 请求方法 */
@@ -669,8 +479,6 @@ export interface RequestConfig<MockUrl extends string = string, DevUrl extends s
     requestBodyType: RequestBodyType;
     /** 返回数据类型 */
     responseBodyType: ResponseBodyType;
-    /** 数据所在键 */
-    dataKey: DataKey;
     /** 路径参数的名称列表 */
     paramNames: ParamName[];
     /** 查询参数的名称列表 */

package/lib/utils.d.ts

@@ -1,5 +1,5 @@
 import prettier from 'prettier';
-import { Interface, PropDefinitions, Config } from './types';
+import { Interface, PropDefinitions } from './types';
 import { JSONSchema4 } from 'json-schema';
 /**
  * 抛出错误。
@@ -61,7 +61,7 @@ export declare function propDefinitionsToJsonSchema(propDefinitions: PropDefinit
  * 获取prettier配置
  * @returns
  */
-export declare function getPrettier(filePath?: string): prettier.Options;
+export declare function getPrettier(): prettier.Options;
 export declare function preprocessSchema(schema: JSONSchema4): JSONSchema4;
 /**
  * 根据 JSONSchema 对象生产 TypeScript 类型定义。
@@ -72,7 +72,7 @@ export declare function preprocessSchema(schema: JSONSchema4): JSONSchema4;
  */
 export declare function jsonSchemaToTsCode(jsonSchema: JSONSchema4, typeName: string): Promise<string>;
 export declare function getRequestDataJsonSchema(interfaceInfo: Interface): JSONSchema4;
-export declare function getResponseDataJsonSchema(interfaceInfo: Interface, dataKey?: string): JSONSchema4;
+export declare function getResponseDataJsonSchema(interfaceInfo: Interface): JSONSchema4;
 export declare function sortByWeights<T extends {
     weights: number[];
 }>(list: T[]): T[];
@@ -83,15 +83,9 @@ export declare function sortByWeights<T extends {
  * @returns
  * https://prettier.io/docs/en/options.html
  */
-export declare function formatContent(content: string, prettierConfigPath?: string): string;
+export declare function formatContent(content: string): string;
 /**
  * 通用生成文件顶部注释
  * @returns
  */
 export declare function topNotesContent(): string;
-/**
- * filter处理函数
- * @param interfaceFilter
- * @returns
- */
-export declare const filterHandler: (interfaceFilter?: Config['filter']) => (path: string, id?: number) => boolean;

package/lib/utils.js

@@ -180,7 +180,7 @@ var __importDefault = void 0 && (void 0).__importDefault || function (mod) {
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.filterHandler = exports.topNotesContent = exports.formatContent = exports.sortByWeights = exports.getResponseDataJsonSchema = exports.getRequestDataJsonSchema = exports.jsonSchemaToTsCode = exports.preprocessSchema = exports.getPrettier = exports.propDefinitionsToJsonSchema = exports.mockjsTemplateToJsonSchema = exports.jsonToJsonSchema = exports.jsonSchemaStringToJsonSchema = exports.processJsonSchema = exports.getNormalizedRelativePath = exports.toUnixPath = exports.throwError = void 0;
+exports.topNotesContent = exports.formatContent = exports.sortByWeights = exports.getResponseDataJsonSchema = exports.getRequestDataJsonSchema = exports.jsonSchemaToTsCode = exports.preprocessSchema = exports.getPrettier = exports.propDefinitionsToJsonSchema = exports.mockjsTemplateToJsonSchema = exports.jsonToJsonSchema = exports.jsonSchemaStringToJsonSchema = exports.processJsonSchema = exports.getNormalizedRelativePath = exports.toUnixPath = exports.throwError = void 0;
 
 var json5_1 = __importDefault(require("json5"));
 
@@ -427,13 +427,8 @@ exports.propDefinitionsToJsonSchema = propDefinitionsToJsonSchema;
  * @returns
  */
 
-function getPrettier(filePath) {
-  // 从项目中获取prettier配置文件
-  var configPath = prettier_1.default.resolveConfigFile.sync(filePath && path_1.default.resolve(filePath) || process.cwd());
-  var config = configPath && prettier_1.default.resolveConfig.sync(configPath) || {};
-  return config ? __assign({
-    parser: 'babel-ts'
-  }, config) : {
+function getPrettier() {
+  return {
     printWidth: 120,
     tabWidth: 2,
     singleQuote: true,
@@ -678,7 +673,7 @@ function getRequestDataJsonSchema(interfaceInfo) {
 
 exports.getRequestDataJsonSchema = getRequestDataJsonSchema;
 
-function getResponseDataJsonSchema(interfaceInfo, dataKey) {
+function getResponseDataJsonSchema(interfaceInfo) {
   var jsonSchema = {};
 
   switch (interfaceInfo.res_body_type) {
@@ -695,12 +690,6 @@ function getResponseDataJsonSchema(interfaceInfo, dataKey) {
       };
       break;
   }
-  /* istanbul ignore if */
-
-
-  if (dataKey && jsonSchema && jsonSchema.properties && jsonSchema.properties[dataKey]) {
-    jsonSchema = jsonSchema.properties[dataKey];
-  }
 
   return jsonSchema;
 }
@@ -738,9 +727,9 @@ exports.sortByWeights = sortByWeights;
  * https://prettier.io/docs/en/options.html
  */
 
-function formatContent(content, prettierConfigPath) {
+function formatContent(content) {
   // 从项目中获取prettier配置文件
-  var config = getPrettier(prettierConfigPath);
+  var config = getPrettier();
   var prettyOutputContent = prettier_1.default.format(content, config);
   return prettyOutputContent;
 }
@@ -752,32 +741,7 @@ exports.formatContent = formatContent;
  */
 
 function topNotesContent() {
-  return "\n  /**\n   * Created By api-ts-generator\n   */\n\n  ";
+  return "\n  /**\n   * Created By open-api-typescript-request-generator\n   */\n\n  ";
 }
 
-exports.topNotesContent = topNotesContent;
-/**
- * filter处理函数
- * @param interfaceFilter
- * @returns
- */
-
-var filterHandler = function filterHandler(interfaceFilter) {
-  return function (path, id) {
-    if (interfaceFilter instanceof RegExp && !interfaceFilter.test(path)) {
-      return false;
-    }
-
-    if (interfaceFilter instanceof Array && !interfaceFilter.includes(path)) {
-      return false;
-    }
-
-    if (interfaceFilter instanceof Function && !interfaceFilter(path, id)) {
-      return false;
-    }
-
-    return true;
-  };
-};
-
-exports.filterHandler = filterHandler;
+exports.topNotesContent = topNotesContent;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "open-api-typescript-request-generator",
-  "version": "0.0.1-alpha.2",
+  "version": "0.0.2",
   "author": "zimv <zimudashiren@163.com>",
   "main": "./lib/index.js",
   "module": "./es/index.js",
@@ -15,7 +15,8 @@
   "scripts": {
     "build": "father build",
     "gen": "rm -rf ./api & tsx test/gen.ts --type-check false gen",
-    "init": "tsx watch test/gen.ts --type-check false init",
+    "gen:api-1": "tsx test/gen.ts --type-check false gen -n api-1",
+    "init": "tsx test/gen.ts --type-check false init",
     "publishOnly": "npm run build",
     "release": "npm run build && standard-version && git push --follow-tags origin master && npm publish",
     "requestTest": "tsx watch test/requestTest.ts --type-check false",

package/es/requestYapiData.d.ts

@@ -1,153 +0,0 @@
-/**
- * 获取yapi数据
- */
-import { Options } from 'got';
-import { CategoryList, Category, Project, SyntheticalConfig, Interface, BaseInterfaceInfo } from './types';
-import prompts from 'prompts';
-declare type ApiConfig = SyntheticalConfig & {
-    method?: Options['method'];
-    /** 异常了是否执行 `process.exit()` */
-    errorExit?: boolean;
-};
-declare const inputs: readonly [{
-    readonly type: "text";
-    readonly name: "email";
-    readonly message: "请输入yapi的邮箱账号";
-    readonly validate: prompts.PrevCaller<"email", string | boolean>;
-}, {
-    readonly type: "password";
-    readonly name: "password";
-    readonly message: "请输入密码";
-    readonly validate: prompts.PrevCaller<"password", string | boolean>;
-}];
-declare type NameValueKey = typeof inputs[number]['name'];
-/**
- * 登录提示框，账号密码录入
- * @returns
- */
-export declare const loginPrompts: (serverUrl?: string) => Promise<{
-    email: string;
-    password: string;
-}>;
-export declare type LoginProps = {
-    [k in NameValueKey]: string;
-};
-export declare type LoginResponseData = {
-    email: string;
-    role: string;
-    study: boolean;
-    type: string;
-    uid: number;
-    username: string;
-};
-declare type FetchApiData = {
-    token?: string;
-    [k: string]: any;
-};
-/**
- *
- * @param url 请求方法
- * @param query
- * @returns
- */
-export declare const fetchApi: <T>(path: string, data: FetchApiData, config?: ApiConfig) => Promise<T>;
-/**
- * 获取项目token
- */
-export declare const fetchToken: (id: number, config?: ApiConfig) => Promise<string>;
-/**
- * 获取项目基本信息 by id
- */
-export declare const fetchProjectById: (config: ApiConfig) => Promise<Project>;
-/**
- * 获取项目基本信息
- *
- */
-export declare const fetchProject: (config: ApiConfig) => Promise<Project>;
-/**
- * 通过导出接口获取项目下的所有接口 by id
- */
-export declare const fetchExportById: (config: ApiConfig) => Promise<Category[]>;
-/**
- * 通过导出接口获取项目下的所有接口
- */
-export declare const fetchExport: (config: ApiConfig) => Promise<Category[]>;
-/**
- * 获取所有接口 by id
- * @param param0
- * @returns
- */
-export declare const fetchInterfaceListById: (config: ApiConfig) => Promise<Category[]>;
-/**
- * 获取所有接口
- * @param param0
- * @returns
- */
-export declare const fetchInterfaceList: (config: ApiConfig) => Promise<Category[]>;
-/**
- * 获取项目信息 by id
- * @param config
- * @returns
- */
-export declare const fetchProjectInfoById: (config: ApiConfig) => Promise<{
-    cats: CategoryList;
-    getMockUrl: () => string;
-    _id: number;
-    name: string;
-    desc: string; /** 异常了是否执行 `process.exit()` */
-    basepath: string;
-    tag: string[];
-    env: {
-        name: string;
-        domain: string;
-    }[];
-    token?: string;
-    cat: Category[];
-    components?: object[];
-}>;
-/**
- * 获取项目信息
- * @param config
- * @returns
- */
-export declare const fetchProjectInfo: (config: ApiConfig) => Promise<{
-    cats: CategoryList;
-    getMockUrl: () => string;
-    _id: number;
-    name: string;
-    desc: string; /** 异常了是否执行 `process.exit()` */
-    basepath: string;
-    tag: string[];
-    env: {
-        name: string;
-        domain: string;
-    }[];
-    token?: string;
-    cat: Category[];
-    components?: object[];
-}>;
-/**
- * 获取单个接口信息 by id
- */
-export declare const fetchInterfaceById: (id: number, config?: ApiConfig) => Promise<Interface>;
-/**
- * 获取分类下的接口列表信息 by id
- */
-export declare const fetchCatInterfaceById: (catid: number, config?: ApiConfig) => Promise<BaseInterfaceInfo[]>;
-/**
- * 批量获取分类下的详细接口信息
- * @param categoryList
- * @param config
- * @returns
- */
-export declare const getInterfacesByCategoryIds: (categoryIds: number[], config?: ApiConfig) => Promise<Interface[]>;
-/**
- * 获取项目信息和接口
- * @param config
- * @returns
- */
-export declare const getProjectInfoAndInterfaces: (config: ApiConfig) => Promise<{
-    projectInfo: Project;
-    allInterfaceList: Category[];
-}>;
-export {};