openapi-ts-request 1.10.0 → 1.11.0

package/README.md

@@ -186,7 +186,6 @@ $ openapi --help
     -o, --output <string>               output directory
     -cfn, --configFileName <string>     config file name
     -cfp, --configFilePath <string>     config file path
-    -u, --uniqueKey <string>            unique key
     --requestLibPath <string>           custom request lib path, for example: "@/request", "node-fetch" (default: "axios")
     -f, --full <boolean>                full replacement (default: true)
     --enableLogging <boolean>           open the log (default: false)
@@ -211,6 +210,7 @@ $ openapi --help
     --isOnlyGenTypeScriptType <boolean> only generate typescript type (default: false)
     --isCamelCase <boolean>             camelCase naming of controller files and request client (default: true)
     --isSupportParseEnumDesc <boolean>  parse enum description to generate enum label (default: false)
+    --supportParseEnumDescByReg <string> custom regex for parsing enum description
     -h, --help                          display help for command
 ```
 
@@ -252,6 +252,7 @@ openapi --i ./spec.json --o ./apis
 | isOnlyGenTypeScriptType | 否 | boolean | false | 仅生成 typescript 类型 |
 | isCamelCase | 否 | boolean | true | 小驼峰命名文件和请求函数 |
 | isSupportParseEnumDesc | 否 | boolean | false | 解析枚举描述生成枚举标签，格式参考：`系统用户角色:User(普通用户)=0,Agent(经纪人)=1,Admin(管理员)=2` |
+| supportParseEnumDescByReg | 否 | string \| RegExp | - | 自定义正则表达式，用于解析 description 中的枚举定义。如果设置了此参数，将使用此正则表达式替代默认的 parseDescriptionEnum 方法。例如：`/([^\s=<>/&;]+(?:\s+[^\s=<>/&;]+)*)\s*=\s*(\d+)/g` 可以匹配 "普通 = 0" 或 "SampleMaker = 1" 这样的格式 |
 | binaryMediaTypes | 否 | string[] | - | 自定义二进制媒体类型列表，默认包含：['application/octet-stream', 'application/pdf', 'image/*', 'video/*', 'audio/*'] |
 | hook | 否 | [Custom Hook](#Custom-Hook) | - | 自定义 hook |
 

package/dist/bin/cli.js

@@ -9,14 +9,12 @@ const log_1 = require("../log");
 const readConfig_1 = require("../readConfig");
 commander_1.program
     .option('-cfn, --configFileName <string>', 'config file name')
-    .option('-cfp, --configFilePath <string>', 'config file path')
-    .option('-u, --uniqueKey <string>', 'unique key');
+    .option('-cfp, --configFilePath <string>', 'config file path');
 commander_1.program.parse();
 const options = commander_1.program.opts();
 /**
  * 1. 执行 cli 命令读取配置文件，已经使用 openapi.ts 替代了 cli.ts，后期会废弃 cli.ts
- * 2. 如果配置文件中有 uniqueKey，则根据 uniqueKey 生成 service
- * 3. 如果配置文件中没有 uniqueKey，且有多个 service，则交互式选择要生成的 service
+ * 2. 如果配置文件有多个 service，则交互式选择要生成的 service
  */
 function run() {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
@@ -33,11 +31,8 @@ function run() {
                     : [config];
                 /** 是否交互式 */
                 let isInteractive = false;
-                if (options.uniqueKey) {
-                    configs = configs.filter((config) => config.uniqueKey === options.uniqueKey);
-                }
-                else if (configs.length > 1) {
-                    // 如果没有指定 uniqueKey，并且有多个配置，则交互式选择
+                if (configs.length > 1) {
+                    // 有多个配置，则交互式选择
                     isInteractive = true;
                     console.log(''); // 添加一个空行
                     (0, prompts_1.intro)('🎉 欢迎使用 openapi-ts-request 生成器');
@@ -63,7 +58,8 @@ function run() {
                     const result = results[i];
                     if (result.status === 'rejected') {
                         const cnf = configs[i];
-                        errorMsg += `${cnf.uniqueKey}${cnf.uniqueKey && ':'}${result.reason}\n`;
+                        const label = cnf.describe || cnf.schemaPath;
+                        errorMsg += `${label}${label && ':'}${result.reason}\n`;
                     }
                 }
                 if (errorMsg) {

package/dist/bin/openapi.js

@@ -18,7 +18,6 @@ const params = commander_1.program
     .option('-o, --output <string>', 'output directory')
     .option('-cfn, --configFileName <string>', 'config file name')
     .option('-cfp, --configFilePath <string>', 'config file path')
-    .option('-u, --uniqueKey <string>', 'unique key')
     .option('--requestLibPath <string>', 'custom request lib path, for example: "@/request", "node-fetch" (default: "axios")')
     .option('-f, --full <boolean>', 'full replacement', true)
     .option('--enableLogging <boolean>', 'open the log', false)
@@ -43,6 +42,7 @@ const params = commander_1.program
     .option('--isOnlyGenTypeScriptType <boolean>', 'only generate typescript type', false)
     .option('--isCamelCase <boolean>', 'camelCase naming of controller files and request client', true)
     .option('--isSupportParseEnumDesc <boolean>', 'parse enum description to generate enum label', false)
+    .option('--supportParseEnumDescByReg <string>', 'custom regex for parsing enum description')
     .parse(process.argv)
     .opts();
 function getPath(path) {
@@ -81,6 +81,7 @@ const baseGenerate = (_params_) => {
         isOnlyGenTypeScriptType: JSON.parse(_params_.isOnlyGenTypeScriptType) === true,
         isCamelCase: JSON.parse(_params_.isCamelCase) === true,
         isSupportParseEnumDesc: JSON.parse(_params_.isSupportParseEnumDesc) === true,
+        supportParseEnumDescByReg: _params_.supportParseEnumDescByReg,
     };
     return options;
 };
@@ -102,11 +103,8 @@ function run() {
                 let configs = Array.isArray(cnf) ? cnf : [cnf];
                 /** 是否交互式 */
                 let isInteractive = false;
-                if (params.uniqueKey) {
-                    configs = configs.filter((config) => config.uniqueKey === params.uniqueKey);
-                }
-                else if (configs.length > 1) {
-                    // 如果没有指定 uniqueKey，并且有多个配置，则交互式选择
+                if (configs.length > 1) {
+                    // 有多个配置，则交互式选择
                     isInteractive = true;
                     console.log(''); // 添加一个空行
                     (0, prompts_1.intro)('🎉 欢迎使用 openapi-ts-request 生成器');
@@ -132,7 +130,8 @@ function run() {
                     const result = results[i];
                     if (result.status === 'rejected') {
                         const cnf = configs[i];
-                        errorMsg += `${cnf.uniqueKey}${cnf.uniqueKey && ':'}${result.reason}\n`;
+                        const label = cnf.describe || cnf.schemaPath;
+                        errorMsg += `${label}${label && ':'}${result.reason}\n`;
                     }
                 }
                 if (errorMsg) {

package/dist/generator/serviceGenarator.js

@@ -1032,8 +1032,12 @@ class ServiceGenerator {
         }
         else {
             if (config_2.numberEnum.includes(schemaObject.type) || (0, util_2.isAllNumber)(enumArray)) {
-                if (this.config.isSupportParseEnumDesc && schemaObject.description) {
-                    const enumMap = (0, util_2.parseDescriptionEnum)(schemaObject.description);
+                if ((this.config.isSupportParseEnumDesc ||
+                    this.config.supportParseEnumDescByReg) &&
+                    schemaObject.description) {
+                    const enumMap = this.config.isSupportParseEnumDesc
+                        ? (0, util_2.parseDescriptionEnum)(schemaObject.description)
+                        : (0, util_2.parseDescriptionEnumByReg)(schemaObject.description, this.config.supportParseEnumDescByReg);
                     enumLabelTypeStr = `{${(0, lodash_1.map)(enumArray, (value) => {
                         const enumLabel = enumMap.get(Number(value));
                         return `${Number(value)}:"${enumLabel}"`;

package/dist/generator/util.d.ts

@@ -23,6 +23,13 @@ export declare function isAllNumeric(arr: any): boolean;
 export declare function isAllNumber(arr: any): boolean;
 export declare function capitalizeFirstLetter(str: string): string;
 export declare const parseDescriptionEnum: (description: string) => Map<number, string>;
+/**
+ * 通过自定义正则表达式解析 description 中的枚举翻译
+ * @param description 描述文本
+ * @param regex 自定义正则表达式，用于匹配枚举项，例如：(\S+)\s*=\s*(\S+)
+ * @returns Map<number, string> 枚举值到标签的映射
+ */
+export declare const parseDescriptionEnumByReg: (description: string, regex: string | RegExp) => Map<number, string>;
 /**
  * 获取默认的二进制媒体类型列表
  */

package/dist/generator/util.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAxiosResponseType = exports.getBinaryResponseType = exports.isBinaryMediaType = exports.getBinaryMediaTypes = exports.getDefaultBinaryMediaTypes = exports.parseDescriptionEnum = void 0;
+exports.getAxiosResponseType = exports.getBinaryResponseType = exports.isBinaryMediaType = exports.getBinaryMediaTypes = exports.getDefaultBinaryMediaTypes = exports.parseDescriptionEnumByReg = exports.parseDescriptionEnum = void 0;
 exports.stripDot = stripDot;
 exports.resolveTypeName = resolveTypeName;
 exports.getRefName = getRefName;
@@ -408,6 +408,54 @@ const parseDescriptionEnum = (description) => {
     return enumMap;
 };
 exports.parseDescriptionEnum = parseDescriptionEnum;
+/**
+ * 通过自定义正则表达式解析 description 中的枚举翻译
+ * @param description 描述文本
+ * @param regex 自定义正则表达式，用于匹配枚举项，例如：(\S+)\s*=\s*(\S+)
+ * @returns Map<number, string> 枚举值到标签的映射
+ */
+const parseDescriptionEnumByReg = (description, regex) => {
+    const enumMap = new Map();
+    if (!description)
+        return enumMap;
+    // 将字符串正则转换为 RegExp 对象，确保有全局标志
+    let regExp;
+    if (typeof regex === 'string') {
+        const flagsMatch = regex.match(/\/([gimsuy]*)$/);
+        if (flagsMatch) {
+            const parts = regex.split('/');
+            const pattern = parts.slice(1, -1).join('/');
+            const flags = flagsMatch[1] || '';
+            regExp = new RegExp(pattern, flags.includes('g') ? flags : flags + 'g');
+        }
+        else {
+            regExp = new RegExp(regex, 'g');
+        }
+    }
+    else {
+        const flags = regex.flags;
+        regExp = flags.includes('g')
+            ? regex
+            : new RegExp(regex.source, flags + 'g');
+    }
+    // 匹配所有结果，然后对每个匹配结果按 = 拆分
+    let match;
+    while ((match = regExp.exec(description)) !== null) {
+        const fullMatch = match[0].trim();
+        // 按 = 拆分，左边是标签，右边是值
+        const parts = fullMatch.split(/\s*=\s*/);
+        if (parts.length >= 2) {
+            const label = parts[0].trim();
+            const valueStr = parts[1].trim();
+            const numValue = Number(valueStr);
+            if (label && valueStr && !isNaN(numValue)) {
+                enumMap.set(numValue, label);
+            }
+        }
+    }
+    return enumMap;
+};
+exports.parseDescriptionEnumByReg = parseDescriptionEnumByReg;
 /**
  * 获取默认的二进制媒体类型列表
  */

package/dist/index.d.ts

@@ -131,6 +131,12 @@ export type GenerateServiceProps = {
      * 是否使用 description 中的枚举定义
      */
     isSupportParseEnumDesc?: boolean;
+    /**
+     * 自定义正则表达式，用于解析 description 中的枚举定义
+     * 如果设置了此参数，将使用此正则表达式替代默认的 parseDescriptionEnum 方法
+     * 例如：/([^\s=<>/&;]+(?:\s+[^\s=<>/&;]+)*)\s*=\s*(\d+)/g 可以匹配 "普通 = 0" 或 "SampleMaker = 1" 这样的格式
+     */
+    supportParseEnumDescByReg?: string | RegExp;
     /**
      * 命名空间名称，默认为API，不需要关注
      */
@@ -143,10 +149,6 @@ export type GenerateServiceProps = {
      * 请求超时时间
      */
     timeout?: number;
-    /**
-     * 多网关唯一标识
-     */
-    uniqueKey?: string;
     /**
      * 自定义二进制媒体类型列表
      * 默认包含: ['application/octet-stream', 'application/pdf', 'image/*', 'video/*', 'audio/*']

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-ts-request",
-  "version": "1.10.0",
+  "version": "1.11.0",
   "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",
@@ -59,7 +59,7 @@
     "@types/lodash": "^4.17.5",
     "@types/memoizee": "^0.4.11",
     "@types/mockjs": "^1.0.10",
-    "@types/node": "^24.0.14",
+    "@types/node": "^25.0.1",
     "@types/nunjucks": "^3.2.6",
     "@types/reserved-words": "^0.1.4",
     "@types/swagger2openapi": "^7.0.4",