open-api-typescript-request-generator 0.0.1

package/lib/genIndex.js

@@ -0,0 +1,354 @@
+"use strict";
+/**
+ * 生成入口文件
+ */
+
+var __makeTemplateObject = void 0 && (void 0).__makeTemplateObject || function (cooked, raw) {
+  if (Object.defineProperty) {
+    Object.defineProperty(cooked, "raw", {
+      value: raw
+    });
+  } else {
+    cooked.raw = raw;
+  }
+
+  return cooked;
+};
+
+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 __setModuleDefault = void 0 && (void 0).__setModuleDefault || (Object.create ? function (o, v) {
+  Object.defineProperty(o, "default", {
+    enumerable: true,
+    value: v
+  });
+} : function (o, v) {
+  o["default"] = v;
+});
+
+var __importStar = void 0 && (void 0).__importStar || function (mod) {
+  if (mod && mod.__esModule) return mod;
+  var result = {};
+  if (mod != null) for (var k in mod) {
+    if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+  }
+
+  __setModuleDefault(result, mod);
+
+  return result;
+};
+
+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 __importDefault = void 0 && (void 0).__importDefault || function (mod) {
+  return mod && mod.__esModule ? mod : {
+    "default": mod
+  };
+};
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.genGitRepoIndex = exports.getIndexGitInfo = exports.prepareIndexFile = void 0;
+/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
+
+var fs_extra_1 = __importDefault(require("fs-extra"));
+
+var path_1 = __importDefault(require("path"));
+
+var vtils_1 = require("vtils");
+
+var getOutputPath_1 = require("./getOutputPath");
+
+var utils_1 = require("./utils");
+
+var conso = __importStar(require("./console"));
+/** 提前准备好'src/api/index.ts'文件 */
+
+
+function prepareIndexFile(config) {
+  return __awaiter(this, void 0, void 0, function () {
+    var indexFilePath;
+    return __generator(this, function (_a) {
+      switch (_a.label) {
+        case 0:
+          indexFilePath = (0, getOutputPath_1.getOutputFilePath)(config, 'index.ts');
+          return [4
+          /*yield*/
+          , fs_extra_1.default.pathExists(indexFilePath)];
+
+        case 1:
+          if (!_a.sent()) {
+            fs_extra_1.default.outputFileSync(indexFilePath, (0, vtils_1.dedent)(templateObject_1 || (templateObject_1 = __makeTemplateObject(["", ""], ["", ""])), (0, utils_1.topNotesContent)()) + '\n');
+          }
+
+          return [2
+          /*return*/
+          ];
+      }
+    });
+  });
+}
+
+exports.prepareIndexFile = prepareIndexFile;
+
+exports.default = function (config, categoryList) {
+  return __awaiter(void 0, void 0, void 0, function () {
+    var prettierConfigPath, indexFilePath, originFileContent, exportAllInterface, content;
+    return __generator(this, function (_a) {
+      switch (_a.label) {
+        case 0:
+          prettierConfigPath = config.prettierConfigPath;
+          indexFilePath = (0, getOutputPath_1.getOutputFilePath)(config, 'index.ts');
+          originFileContent = '';
+          return [4
+          /*yield*/
+          , fs_extra_1.default.pathExists(indexFilePath)];
+
+        case 1:
+          if (_a.sent()) {
+            originFileContent = fs_extra_1.default.readFileSync(indexFilePath, {
+              encoding: 'utf-8'
+            });
+          }
+
+          exportAllInterface = categoryList.reduce(function (list, _a, index) {
+            var projectId = _a.projectId; // return `export * from  "./${projectId}/${categoryId}"`;
+
+            if (originFileContent.indexOf("".concat(projectId)) === -1) {
+              list.push("export * from  \"./".concat(projectId, "\""));
+            }
+
+            return list;
+          }, []);
+          content = "\n    ".concat(exportAllInterface.join(';'), "\n  "); // 输出index文件
+
+          fs_extra_1.default.appendFile(indexFilePath, (0, utils_1.formatContent)((0, vtils_1.dedent)(templateObject_2 || (templateObject_2 = __makeTemplateObject(["", ""], ["", ""])), content), prettierConfigPath));
+          return [2
+          /*return*/
+          ];
+      }
+    });
+  });
+};
+
+var getIndexGitInfo = function getIndexGitInfo(config) {
+  var indexFilePath = (0, getOutputPath_1.getOutputFilePath)(config, 'index.ts');
+  var result = {};
+
+  try {
+    var fileContent_1 = fs_extra_1.default.readFileSync(indexFilePath, {
+      encoding: 'utf-8'
+    });
+    ['repo', 'branch', 'commitId'].forEach(function (k) {
+      var reg = new RegExp("".concat(k, ":\\s?([A-Za-z0-9_\\-/://]+)\\s"));
+      var matchRes = fileContent_1.match(reg) || [];
+      result[k] = matchRes[1] || '';
+    });
+  } catch (e) {
+    conso.tips("\u672A\u627E\u5230".concat(indexFilePath, "\uFF0C\u5C06\u91CD\u65B0\u751F\u6210"));
+  }
+
+  return result;
+};
+
+exports.getIndexGitInfo = getIndexGitInfo;
+
+var genGitRepoIndex = function genGitRepoIndex(config, filePathList, notes) {
+  return __awaiter(void 0, void 0, void 0, function () {
+    var prettierConfigPath, indexFilePath, originFileContent, exportAllInterface, content;
+    return __generator(this, function (_a) {
+      switch (_a.label) {
+        case 0:
+          prettierConfigPath = config.prettierConfigPath;
+          indexFilePath = (0, getOutputPath_1.getOutputFilePath)(config, 'index.ts');
+          originFileContent = '';
+          return [4
+          /*yield*/
+          , fs_extra_1.default.pathExists(indexFilePath)];
+
+        case 1:
+          if (_a.sent()) {
+            originFileContent = fs_extra_1.default.readFileSync(indexFilePath, {
+              encoding: 'utf-8'
+            });
+          }
+
+          exportAllInterface = filePathList.reduce(function (list, filePath, index) {
+            if (originFileContent.indexOf(filePath) === -1) {
+              list.push("export * from  \"./".concat(path_1.default.join('./', filePath), "\""));
+            }
+
+            return list;
+          }, []);
+          content = "\n    ".concat(exportAllInterface.join(';'), "\n  "); // 输出index文件
+
+          fs_extra_1.default.appendFile(indexFilePath, (0, utils_1.formatContent)((0, vtils_1.dedent)(templateObject_3 || (templateObject_3 = __makeTemplateObject(["", ""], ["", ""])), content), prettierConfigPath));
+          return [2
+          /*return*/
+          ];
+      }
+    });
+  });
+};
+
+exports.genGitRepoIndex = genGitRepoIndex;
+var templateObject_1, templateObject_2, templateObject_3;

package/lib/genRequest.d.ts

@@ -0,0 +1,3 @@
+import { Config } from './types';
+declare const _default: (config: Config) => Promise<void>;
+export default _default;

package/lib/genRequest.js

@@ -0,0 +1,216 @@
+"use strict";
+
+var __makeTemplateObject = void 0 && (void 0).__makeTemplateObject || function (cooked, raw) {
+  if (Object.defineProperty) {
+    Object.defineProperty(cooked, "raw", {
+      value: raw
+    });
+  } else {
+    cooked.raw = raw;
+  }
+
+  return cooked;
+};
+
+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 __importDefault = void 0 && (void 0).__importDefault || function (mod) {
+  return mod && mod.__esModule ? mod : {
+    "default": mod
+  };
+};
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
+
+var fs_extra_1 = __importDefault(require("fs-extra"));
+
+var vtils_1 = require("vtils");
+
+var getOutputPath_1 = require("./getOutputPath");
+
+var utils_1 = require("./utils");
+
+exports.default = function (config) {
+  return __awaiter(void 0, void 0, void 0, function () {
+    var prettierConfigPath, defaultRequestLib, rawRequestFunctionFilePath, content;
+    return __generator(this, function (_a) {
+      switch (_a.label) {
+        case 0:
+          prettierConfigPath = config.prettierConfigPath, defaultRequestLib = config.defaultRequestLib;
+          if (defaultRequestLib === false) return [2
+          /*return*/
+          ];
+          rawRequestFunctionFilePath = (0, getOutputPath_1.getOutputFilePath)(config, 'request.ts');
+          if (!!config.typesOnly) return [3
+          /*break*/
+          , 2];
+          return [4
+          /*yield*/
+          , fs_extra_1.default.pathExists(rawRequestFunctionFilePath)];
+
+        case 1:
+          if (_a.sent()) {
+            // conso.tips(`输出目录${outputFilePath}下检测到已有request.ts，如果需要重新生成，请删除该文件 \n`);
+            return [2
+            /*return*/
+            ];
+          }
+
+          _a.label = 2;
+
+        case 2:
+          content = "\n  ".concat((0, utils_1.topNotesContent)(), "\n\n  import request,{ AxiosRequestConfig } from 'axios';  // axios\u7248\u672C>=0.18.1\n\n  const instance = request.create({\n    withCredentials: true,\n    baseURL: process.env.BASE_URL,\n  });\n\n  // \u81EA\u5B9A\u4E49request\u62E6\u622A\u5668\n  instance.interceptors.request.use((config) => {\n    return  {\n      ...config\n    }\n  });\n\n  // \u81EA\u5B9A\u4E49response\u62E6\u622A\u5668\uFF0C\n  // \u6CE8\u610F\uFF1A\u5982\u679C\u4FEE\u6539\u63A5\u53E3\u6B63\u5E38\u8FD4\u56DE\u7684\u7ED3\u6784\uFF0C\u5BF9\u5E94\u7684response\u58F0\u660E\u9700\u8981\u4FEE\u6539\n  instance.interceptors.response.use((r) => {\n    const { data, config } = r;\n    if (data.code === 0) {\n\n      return data.data;\n    }\n    return Promise.reject(data);\n  });\n\n  export default {\n    get: <RQ, RP>(url: string, config?: AxiosRequestConfig) => {\n      return instance.get<RP>(url, config);\n    },\n    post: <RQ, RP>(url: string, config?: AxiosRequestConfig) => {\n      return instance.post<RP>(url, config);\n    }\n  };\n");
+          fs_extra_1.default.outputFile(rawRequestFunctionFilePath, (0, utils_1.formatContent)((0, vtils_1.dedent)(templateObject_1 || (templateObject_1 = __makeTemplateObject(["", ""], ["", ""])), content), prettierConfigPath));
+          return [2
+          /*return*/
+          ];
+      }
+    });
+  });
+};
+
+var templateObject_1;

package/lib/getOutputPath.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 生成入口文件
+ */
+import { Config } from './types';
+export declare const getOutputFilePath: (config: Config, file: string) => string;

package/lib/getOutputPath.js

@@ -0,0 +1,28 @@
+"use strict";
+/**
+ * 生成入口文件
+ */
+
+var __importDefault = void 0 && (void 0).__importDefault || function (mod) {
+  return mod && mod.__esModule ? mod : {
+    "default": mod
+  };
+};
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getOutputFilePath = void 0;
+/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
+
+var path_1 = __importDefault(require("path"));
+
+var getOutputFilePath = function getOutputFilePath(config, file) {
+  var _a = path_1.default.parse(config.outputFilePath || ''),
+      dir = _a.dir,
+      name = _a.name;
+
+  return path_1.default.join(dir, name, file);
+};
+
+exports.getOutputFilePath = getOutputFilePath;

package/lib/helpers.d.ts

@@ -0,0 +1,63 @@
+import type { AppendOptions } from 'form-data';
+import type { Config, RequestConfig, RequestFunctionParams } from './types';
+/**
+ * 定义配置。
+ *
+ * @param config 配置
+ */
+export declare function defineConfig(config: Partial<Config> | Partial<Config>[]): Config[];
+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;
+}
+/**
+ * 解析请求数据，从请求数据中分离出普通数据和文件数据。
+ *
+ * @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;
+/**
+ * 顺序执行异步函数队列
+ * @param fns
+ * @param results
+ * @returns
+ */
+export declare const asyncFnArrayOrderRun: <T = any>(fns: (() => Promise<T>)[], results?: T[]) => Promise<T[]>;
+/**
+ * 并发请求队列
+ * @param fns
+ * @param limit
+ * @returns
+ */
+export declare const autoAsyncSplitQueue: <T = any>(fns: (() => Promise<T>)[], limit?: number) => Promise<Awaited<T>[]>;