open-api-typescript-request-generator 0.0.1

package/lib/helpers.js

@@ -0,0 +1,458 @@
+"use strict";
+
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+
+var __assign = void 0 && (void 0).__assign || function () {
+  __assign = Object.assign || function (t) {
+    for (var s, i = 1, n = arguments.length; i < n; i++) {
+      s = arguments[i];
+
+      for (var p in s) {
+        if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
+      }
+    }
+
+    return t;
+  };
+
+  return __assign.apply(this, arguments);
+};
+
+var __awaiter = void 0 && (void 0).__awaiter || function (thisArg, _arguments, P, generator) {
+  function adopt(value) {
+    return value instanceof P ? value : new P(function (resolve) {
+      resolve(value);
+    });
+  }
+
+  return new (P || (P = Promise))(function (resolve, reject) {
+    function fulfilled(value) {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    }
+
+    function rejected(value) {
+      try {
+        step(generator["throw"](value));
+      } catch (e) {
+        reject(e);
+      }
+    }
+
+    function step(result) {
+      result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected);
+    }
+
+    step((generator = generator.apply(thisArg, _arguments || [])).next());
+  });
+};
+
+var __generator = void 0 && (void 0).__generator || function (thisArg, body) {
+  var _ = {
+    label: 0,
+    sent: function sent() {
+      if (t[0] & 1) throw t[1];
+      return t[1];
+    },
+    trys: [],
+    ops: []
+  },
+      f,
+      y,
+      t,
+      g;
+  return g = {
+    next: verb(0),
+    "throw": verb(1),
+    "return": verb(2)
+  }, typeof Symbol === "function" && (g[Symbol.iterator] = function () {
+    return this;
+  }), g;
+
+  function verb(n) {
+    return function (v) {
+      return step([n, v]);
+    };
+  }
+
+  function step(op) {
+    if (f) throw new TypeError("Generator is already executing.");
+
+    while (_) {
+      try {
+        if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+        if (y = 0, t) op = [op[0] & 2, t.value];
+
+        switch (op[0]) {
+          case 0:
+          case 1:
+            t = op;
+            break;
+
+          case 4:
+            _.label++;
+            return {
+              value: op[1],
+              done: false
+            };
+
+          case 5:
+            _.label++;
+            y = op[1];
+            op = [0];
+            continue;
+
+          case 7:
+            op = _.ops.pop();
+
+            _.trys.pop();
+
+            continue;
+
+          default:
+            if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
+              _ = 0;
+              continue;
+            }
+
+            if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
+              _.label = op[1];
+              break;
+            }
+
+            if (op[0] === 6 && _.label < t[1]) {
+              _.label = t[1];
+              t = op;
+              break;
+            }
+
+            if (t && _.label < t[2]) {
+              _.label = t[2];
+
+              _.ops.push(op);
+
+              break;
+            }
+
+            if (t[2]) _.ops.pop();
+
+            _.trys.pop();
+
+            continue;
+        }
+
+        op = body.call(thisArg, _);
+      } catch (e) {
+        op = [6, e];
+        y = 0;
+      } finally {
+        f = t = 0;
+      }
+    }
+
+    if (op[0] & 5) throw op[1];
+    return {
+      value: op[0] ? op[1] : void 0,
+      done: true
+    };
+  }
+};
+
+var __spreadArray = void 0 && (void 0).__spreadArray || function (to, from, pack) {
+  if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+    if (ar || !(i in from)) {
+      if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+      ar[i] = from[i];
+    }
+  }
+  return to.concat(ar || Array.prototype.slice.call(from));
+};
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.autoAsyncSplitQueue = exports.asyncFnArrayOrderRun = exports.prepare = exports.parseRequestData = exports.FileData = exports.defineConfig = void 0;
+/**
+ * 定义配置。
+ *
+ * @param config 配置
+ */
+
+function defineConfig(config) {
+  var configs = config instanceof Array ? config : [config];
+  var final = configs.map(function (item) {
+    return __assign({
+      serverUrl: '',
+      typesOnly: false,
+      target: 'typescript',
+      prodEnvName: 'local',
+      outputFilePath: 'src/api',
+      dataKey: 'data',
+      jsonSchema: {
+        enabled: false
+      }
+    }, item);
+  });
+  return final;
+}
+
+exports.defineConfig = defineConfig;
+
+var FileData =
+/** @class */
+function () {
+  /**
+   * 文件数据辅助类，统一网页、小程序等平台的文件上传。
+   *
+   * @param originalFileData 原始文件数据
+   * @param options 若使用内部的 getFormData，则选项会被其使用
+   */
+  function FileData(originalFileData, options) {
+    this.originalFileData = originalFileData;
+    this.options = options;
+  }
+  /**
+   * 获取原始文件数据。
+   *
+   * @returns 原始文件数据
+   */
+
+
+  FileData.prototype.getOriginalFileData = function () {
+    return this.originalFileData;
+  };
+  /**
+   * 获取选项。
+   */
+
+
+  FileData.prototype.getOptions = function () {
+    return this.options;
+  };
+
+  return FileData;
+}();
+
+exports.FileData = FileData;
+/**
+ * 解析请求数据，从请求数据中分离出普通数据和文件数据。
+ *
+ * @param [requestData] 要解析的请求数据
+ * @returns 包含普通数据(data)和文件数据(fileData)的对象，data、fileData 为空对象时，表示没有此类数据
+ */
+
+function parseRequestData(requestData) {
+  var result = {
+    data: {},
+    fileData: {}
+  };
+  /* istanbul ignore else */
+
+  if (requestData != null) {
+    if (_typeof(requestData) === 'object' && !Array.isArray(requestData)) {
+      Object.keys(requestData).forEach(function (key) {
+        if (requestData[key] && requestData[key] instanceof FileData) {
+          result.fileData[key] = requestData[key].getOriginalFileData();
+        } else {
+          result.data[key] = requestData[key];
+        }
+      });
+    } else {
+      result.data = requestData;
+    }
+  }
+
+  return result;
+}
+
+exports.parseRequestData = parseRequestData;
+/**
+ * 准备要传给请求函数的参数。
+ */
+
+function prepare(requestConfig, requestData) {
+  var requestPath = requestConfig.path;
+
+  var _a = parseRequestData(requestData),
+      data = _a.data,
+      fileData = _a.fileData;
+
+  var dataIsObject = data != null && _typeof(data) === 'object' && !Array.isArray(data);
+
+  if (dataIsObject) {
+    // 替换路径参数
+    if (Array.isArray(requestConfig.paramNames) && requestConfig.paramNames.length > 0) {
+      Object.keys(data).forEach(function (key) {
+        if (requestConfig.paramNames.indexOf(key) >= 0) {
+          // ref: https://github.com/YMFE/yapi/blob/master/client/containers/Project/Interface/InterfaceList/InterfaceEditForm.js#L465
+          requestPath = requestPath.replace(new RegExp("\\{".concat(key, "\\}"), 'g'), data[key]).replace(new RegExp("/:".concat(key, "(?=/|$)"), 'g'), "/".concat(data[key]));
+          delete data[key];
+        }
+      });
+    } // 追加查询参数到路径上
+
+
+    var queryString_1 = '';
+
+    if (Array.isArray(requestConfig.queryNames) && requestConfig.queryNames.length > 0) {
+      Object.keys(data).forEach(function (key) {
+        if (requestConfig.queryNames.indexOf(key) >= 0) {
+          if (data[key] != null) {
+            queryString_1 += "".concat(queryString_1 ? '&' : '').concat(encodeURIComponent(key), "=").concat(encodeURIComponent(data[key]));
+          }
+
+          delete data[key];
+        }
+      });
+    }
+
+    if (queryString_1) {
+      requestPath += "".concat(requestPath.indexOf('?') > -1 ? '&' : '?').concat(queryString_1);
+    }
+  } // 全部数据
+
+
+  var allData = __assign(__assign({}, dataIsObject ? data : {}), fileData); // 获取表单数据
+
+
+  var getFormData = function getFormData() {
+    var useNativeFormData = typeof FormData !== 'undefined';
+    var useNodeFormData = !useNativeFormData && // https://github.com/fjc0k/vtils/blob/master/src/utils/inNodeJS.ts
+    (typeof global === "undefined" ? "undefined" : _typeof(global)) === 'object' && _typeof(global.process) === 'object' && _typeof(global.process.versions) === 'object' && global.process.versions.node != null;
+    var UniFormData = useNativeFormData ? FormData : useNodeFormData ? eval("require('form-data')") : undefined;
+
+    if (!UniFormData) {
+      throw new Error('当前环境不支持 FormData');
+    }
+
+    var formData = new UniFormData();
+    Object.keys(data).forEach(function (key) {
+      formData.append(key, data[key]);
+    });
+    Object.keys(fileData).forEach(function (key) {
+      var options = requestData[key].getOptions();
+      formData.append(key, fileData[key], useNativeFormData ? options === null || options === void 0 ? void 0 : options.filename : options);
+    });
+    return formData;
+  };
+
+  return __assign(__assign({}, requestConfig), {
+    path: requestPath,
+    rawData: requestData,
+    data: data,
+    hasFileData: fileData && Object.keys(fileData).length > 0,
+    fileData: fileData,
+    allData: allData,
+    getFormData: getFormData
+  });
+}
+
+exports.prepare = prepare;
+/**
+ * 顺序执行异步函数队列
+ * @param fns
+ * @param results
+ * @returns
+ */
+
+var asyncFnArrayOrderRun = function asyncFnArrayOrderRun(fns, results) {
+  return __awaiter(void 0, void 0, void 0, function () {
+    var res, res1;
+    return __generator(this, function (_a) {
+      switch (_a.label) {
+        case 0:
+          if (!fns.length) return [3
+          /*break*/
+          , 3];
+          return [4
+          /*yield*/
+          , fns[0]()];
+
+        case 1:
+          res = _a.sent();
+          return [4
+          /*yield*/
+          , (0, exports.asyncFnArrayOrderRun)(fns.slice(1), __spreadArray(__spreadArray([], results || [], true), [res], false))];
+
+        case 2:
+          res1 = _a.sent();
+          return [2
+          /*return*/
+          , res1];
+
+        case 3:
+          return [2
+          /*return*/
+          , results || []];
+      }
+    });
+  });
+};
+
+exports.asyncFnArrayOrderRun = asyncFnArrayOrderRun;
+/**
+ * 并发请求队列
+ * @param fns
+ * @param limit
+ * @returns
+ */
+
+var autoAsyncSplitQueue = function autoAsyncSplitQueue(fns, limit) {
+  if (limit === void 0) {
+    limit = 1000;
+  }
+
+  return __awaiter(void 0, void 0, void 0, function () {
+    var len, count, splitArray, result;
+    return __generator(this, function (_a) {
+      switch (_a.label) {
+        case 0:
+          len = fns.length;
+          count = 0;
+          splitArray = [];
+
+          while (count < len) {
+            splitArray.push(fns.slice(count, count + limit));
+            count += limit;
+          }
+
+          return [4
+          /*yield*/
+          , (0, exports.asyncFnArrayOrderRun)(splitArray.map(function (item) {
+            return function () {
+              return __awaiter(void 0, void 0, void 0, function () {
+                var res;
+                return __generator(this, function (_a) {
+                  switch (_a.label) {
+                    case 0:
+                      return [4
+                      /*yield*/
+                      , Promise.all(item.map(function (i) {
+                        return i();
+                      }))];
+
+                    case 1:
+                      res = _a.sent();
+                      return [2
+                      /*return*/
+                      , res];
+                  }
+                });
+              });
+            };
+          }))];
+
+        case 1:
+          result = _a.sent();
+          return [2
+          /*return*/
+          , result.flat()];
+      }
+    });
+  });
+};
+
+exports.autoAsyncSplitQueue = autoAsyncSplitQueue;

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types';
+export * from './helpers';

package/lib/index.js

@@ -0,0 +1,34 @@
+"use strict";
+
+var __createBinding = void 0 && (void 0).__createBinding || (Object.create ? function (o, m, k, k2) {
+  if (k2 === undefined) k2 = k;
+  var desc = Object.getOwnPropertyDescriptor(m, k);
+
+  if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+    desc = {
+      enumerable: true,
+      get: function get() {
+        return m[k];
+      }
+    };
+  }
+
+  Object.defineProperty(o, k2, desc);
+} : function (o, m, k, k2) {
+  if (k2 === undefined) k2 = k;
+  o[k2] = m[k];
+});
+
+var __exportStar = void 0 && (void 0).__exportStar || function (m, exports) {
+  for (var p in m) {
+    if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+  }
+};
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+}); // import './typings'; // 需要手动引入，build才不会报错 找不到module！！！！
+
+__exportStar(require("./types"), exports);
+
+__exportStar(require("./helpers"), exports);

package/lib/requestYapiData.d.ts

@@ -0,0 +1,157 @@
+/**
+ * 获取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;
+    getDevUrl: (devEnvName: string) => string;
+    getProdUrl: (prodEnvName: string) => 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;
+    getDevUrl: (devEnvName: string) => string;
+    getProdUrl: (prodEnvName: string) => 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 {};