openapi-ts-request 1.2.0 → 1.3.1

package/dist/util.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOpenAPIConfig = exports.getImportStatement = void 0;
+exports.camelCase = exports.getOpenAPIConfig = exports.getOpenAPIConfigByApifox = exports.getImportStatement = void 0;
 exports.parseSwaggerOrOpenapi = parseSwaggerOrOpenapi;
 exports.translateChineseModuleNodeToEnglish = translateChineseModuleNodeToEnglish;
 const tslib_1 = require("tslib");
@@ -12,7 +12,7 @@ const yaml = tslib_1.__importStar(require("js-yaml"));
 const lodash_1 = require("lodash");
 const node_fs_1 = require("node:fs");
 const swagger2openapi_1 = tslib_1.__importDefault(require("swagger2openapi"));
-const log_1 = tslib_1.__importDefault(require("./log"));
+const log_1 = tslib_1.__importStar(require("./log"));
 const getImportStatement = (requestLibPath) => {
     if (requestLibPath) {
         if (requestLibPath.startsWith('import')) {
@@ -23,7 +23,78 @@ const getImportStatement = (requestLibPath) => {
     return `import { request } from 'axios';`;
 };
 exports.getImportStatement = getImportStatement;
-function getSchema(schemaPath, authorization) {
+const getApifoxIncludeTags = (tags) => {
+    let _tags_ = '*';
+    if (tags && Array.isArray(tags)) {
+        if (!tags.length) {
+            return '*';
+        }
+        _tags_ = [];
+        for (const tag of tags) {
+            if (typeof tag === 'string') {
+                if (tag === '*') {
+                    _tags_ = '*';
+                    break;
+                }
+            }
+            else if (tag instanceof RegExp) {
+                _tags_ = '*';
+                break;
+                // TODO:后期添加支持判断字符串是否为正则
+            }
+            else {
+                _tags_.push(tag);
+            }
+        }
+    }
+    else if (tags) {
+        _tags_ = [tags];
+    }
+    return _tags_;
+};
+/**
+ * 通过 apifox 获取 openapi 文档
+ * @param params {object}
+ * @param params.projectId {string} 项目 id
+ * @param params.locale {string} 语言
+ * @param params.apifoxVersion {string} apifox 版本 目前固定为 2024-03-28 可通过 https://api.apifox.com/v1/versions 获取最新版本
+ * @returns
+ */
+const getSchemaByApifox = (_a) => tslib_1.__awaiter(void 0, [_a], void 0, function* ({ projectId, locale = 'zh-CN', apifoxVersion = '2024-03-28', includeTags, excludeTags = [], apifoxToken, oasVersion = '3.0', exportFormat = 'JSON', includeApifoxExtensionProperties = false, addFoldersToTags = false, }) {
+    try {
+        const body = {
+            scope: {
+                excludeTags,
+            },
+            options: {
+                includeApifoxExtensionProperties,
+                addFoldersToTags,
+            },
+            oasVersion,
+            exportFormat,
+        };
+        const tags = getApifoxIncludeTags(includeTags);
+        if (tags === '*') {
+            body.scope.type = 'ALL';
+        }
+        else {
+            body.scope.type = 'SELECTED_TAGS';
+            body.scope.includeTags = tags;
+        }
+        const res = yield axios_1.default.post(`https://api.apifox.com/v1/projects/${projectId}/export-openapi?locale=${locale}`, body, {
+            headers: {
+                'X-Apifox-Api-Version': apifoxVersion,
+                Authorization: `Bearer ${apifoxToken}`,
+            },
+        });
+        return res.data;
+    }
+    catch (error) {
+        (0, log_1.logError)('fetch openapi error:', error);
+        return null;
+    }
+});
+function getSchema(schemaPath, authorization, timeout) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
         if (schemaPath.startsWith('http')) {
             const isHttps = schemaPath.startsWith('https:');
@@ -34,7 +105,7 @@ function getSchema(schemaPath, authorization) {
                 });
                 const config = isHttps ? { httpsAgent: agent } : { httpAgent: agent };
                 const json = yield axios_1.default
-                    .get(schemaPath, Object.assign(Object.assign({}, config), { headers: { authorization } }))
+                    .get(schemaPath, Object.assign(Object.assign({}, config), { headers: { authorization }, timeout }))
                     .then((res) => res.data);
                 return json;
             }
@@ -80,8 +151,16 @@ function converterSwaggerToOpenApi(swagger) {
         });
     });
 }
-const getOpenAPIConfig = (schemaPath, authorization) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
-    const schema = yield getSchema(schemaPath, authorization);
+const getOpenAPIConfigByApifox = (props) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    const schema = yield getSchemaByApifox(props);
+    if (!schema) {
+        return;
+    }
+    return yield parseSwaggerOrOpenapi(schema);
+});
+exports.getOpenAPIConfigByApifox = getOpenAPIConfigByApifox;
+const getOpenAPIConfig = (schemaPath, authorization, timeout) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    const schema = yield getSchema(schemaPath, authorization, timeout);
     if (!schema) {
         return;
     }
@@ -143,7 +222,7 @@ function translateChineseModuleNodeToEnglish(openAPI) {
                     if (tagName && /[\u3220-\uFA29]/.test(tagName)) {
                         void (0, bing_translate_api_1.translate)(tagName, null, 'en')
                             .then((translateRes) => {
-                            const text = (0, lodash_1.camelCase)(translateRes === null || translateRes === void 0 ? void 0 : translateRes.translation);
+                            const text = (0, exports.camelCase)(translateRes === null || translateRes === void 0 ? void 0 : translateRes.translation);
                             if (text) {
                                 translateMap[tagName] = text;
                                 resolve(text);
@@ -174,3 +253,21 @@ function translateChineseModuleNodeToEnglish(openAPI) {
         });
     });
 }
+/**
+ * Converts a string to camelCase format, with an option to capitalize the first letter.
+ * 将字符串转换为驼峰格式，并可以选择将首字母大写。
+ *
+ * @param {string} str - The string to convert.
+ * @param {string} str - 要转换的字符串。
+ *
+ * @param {boolean} [upper=false] - Whether to capitalize the first letter of the resulting string.
+ * @param {boolean} [upper=false] - 是否将结果字符串的首字母大写。
+ *
+ * @returns {string} The camelCase formatted string, optionally with a capitalized first letter.
+ * @returns {string} 返回驼峰格式的字符串，可选择首字母大写。
+ */
+const camelCase = (str, upper = false) => {
+    const res = (0, lodash_1.camelCase)(str);
+    return upper ? res.charAt(0).toUpperCase() + res.slice(1) : res;
+};
+exports.camelCase = camelCase;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-ts-request",
-  "version": "1.2.0",
+  "version": "1.3.1",
   "description": "Swagger2/OpenAPI3/Apifox to TypeScript/JavaScript, request client(support any client), request mock service, enum and enum translation, react-query/vue-query, type field label, JSON Schemas",
   "engines": {
     "node": ">=18.0.0",
@@ -44,6 +44,7 @@
     "rimraf": "^6.0.1",
     "swagger2openapi": "^7.0.8",
     "tiny-pinyin": "^1.3.2",
+    "ts-morph": "^25.0.1",
     "tslib": "^2.6.3"
   },
   "devDependencies": {
@@ -68,7 +69,7 @@
     "lint-staged": "^15.3.0",
     "openapi-types": "^12.1.3",
     "ts-node": "^10.9.2",
-    "typescript": "5.7.3"
+    "typescript": "5.8.2"
   },
   "keywords": [
     "openapi",
@@ -92,6 +93,7 @@
     "lint": "eslint ./src --report-unused-disable-directives --max-warnings=0",
     "lint:fix": "eslint ./src --report-unused-disable-directives --max-warnings=0 --fix",
     "test": "rm -rf ./test/apis/ ./test/mocks && npm run build && cd ./test && node ./test.js && cd ..",
+    "test:new": "npm run build && cd ./test && node ./test.js && cd ..",
     "test:windows": "rimraf ./test/apis/ ./test/mocks && npm run build && cd ./test && node ./test.js && cd ..",
     "openapi-ts-request": "openapi-ts"
   }