openapi-ts-request 1.1.1 → 1.2.0

package/README.md

@@ -87,7 +87,6 @@ src/apis/pet.ts #接口文件
 
 ```typescript
 // src/apis/pet.ts
-
 /* eslint-disable */
 // @ts-ignore
 import request from 'axios';
@@ -205,6 +204,7 @@ $ openapi --help
     --isTranslateToEnglishTag <boolean> translate chinese tag name to english tag name (default: false)
     --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)
     -h, --help                          display help for command
 ```
 
@@ -241,6 +241,7 @@ openapi --i ./spec.json --o ./apis
 | isTranslateToEnglishTag | 否 | boolean | false | 将中文 tag 名称翻译成英文 tag 名称 |
 | isOnlyGenTypeScriptType | 否 | boolean | false | 仅生成 typescript 类型 |
 | isCamelCase | 否 | boolean | true | 小驼峰命名文件和请求函数 |
+| isSupportParseEnumDesc | 否 | boolean | false | 解析枚举描述生成枚举标签，格式参考：`系统用户角色:User(普通用户)=0,Agent(经纪人)=1,Admin(管理员)=2` |
 | hook | 否 | [Custom Hook](#Custom-Hook) | - | 自定义 hook |
 
 ## 自定义 Hook
@@ -251,7 +252,7 @@ openapi --i ./spec.json --o ./apis
 | customFunctionName | (data: APIDataType) => string | 自定义请求方法函数名称 |
 | customTypeName | (data: APIDataType) => string | 自定义类型名称 |
 | customClassName | (tagName: string) => string | 自定义标签名 |
-| customType | (<br>schemaObject: SchemaObject \| ReferenceObject,<br>namespace: string,<br>originGetType:(schemaObject: SchemaObject \| ReferenceObject, namespace: string) => string,<br>) => string | 自定义类型 <br> _返回非字符串将使用默认方法获取type_ |
+| customType | ({<br>schemaObject: SchemaObject \| ReferenceObject,<br>namespace: string,<br>originGetType:(schemaObject: SchemaObject \| ReferenceObject, namespace: string, schemas?: ComponentsObject['schemas']) => string,<br>schemas?: ComponentsObject['schemas'],<br>}) => string | 自定义类型 <br> _返回非字符串将使用默认方法获取type_ |
 | customFileNames | (<br>operationObject: OperationObject,<br>apiPath: string,<br>apiMethod: string,<br>) => string[] | 自定义生成的请求客户端文件名称，可以返回多个文件名称的数组(表示生成多个文件). <br> _返回为空，则使用默认的方法获取_ |
 
 ## JSON Schemas

package/dist/bin/openapi.js

@@ -34,6 +34,7 @@ const params = commander_1.program
     .option('--isTranslateToEnglishTag <boolean>', 'translate chinese tag name to english tag name', false)
     .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)
     .parse(process.argv)
     .opts();
 function getPath(path) {
@@ -71,6 +72,7 @@ function run() {
                 isTranslateToEnglishTag: JSON.parse(params.isTranslateToEnglishTag) === true,
                 isOnlyGenTypeScriptType: JSON.parse(params.isOnlyGenTypeScriptType) === true,
                 isCamelCase: JSON.parse(params.isCamelCase) === true,
+                isSupportParseEnumDesc: JSON.parse(params.isSupportParseEnumDesc) === true,
             };
             yield (0, index_1.generateService)((0, lodash_1.pickBy)(options, (value) => value !== null && value !== undefined && value !== ''));
             process.exit(0);

package/dist/generator/serviceGenarator.js

@@ -720,7 +720,16 @@ class ServiceGenerator {
         let enumStr = '';
         let enumLabelTypeStr = '';
         if (config_2.numberEnum.includes(schemaObject.type) || (0, util_1.isAllNumber)(enumArray)) {
-            enumStr = `{${(0, lodash_1.map)(enumArray, (value) => `"NUMBER_${value}"=${Number(value)}`).join(',')}}`;
+            if (this.config.isSupportParseEnumDesc && schemaObject.description) {
+                const enumMap = (0, util_1.parseDescriptionEnum)(schemaObject.description);
+                enumStr = `{${(0, lodash_1.map)(enumArray, (value) => {
+                    const enumLabel = enumMap.get(Number(value));
+                    return `${enumLabel}=${Number(value)}`;
+                }).join(',')}}`;
+            }
+            else {
+                enumStr = `{${(0, lodash_1.map)(enumArray, (value) => `"NUMBER_${value}"=${Number(value)}`).join(',')}}`;
+            }
         }
         else if ((0, util_1.isAllNumeric)(enumArray)) {
             enumStr = `{${(0, lodash_1.map)(enumArray, (value) => `"STRING_NUMBER_${value}"="${value}"`).join(',')}}`;
@@ -750,10 +759,19 @@ class ServiceGenerator {
         }
         else {
             if (config_2.numberEnum.includes(schemaObject.type) || (0, util_1.isAllNumber)(enumArray)) {
-                enumLabelTypeStr = `{${(0, lodash_1.map)(enumArray, (value) => `"NUMBER_${value}":${Number(value)}`).join(',')}}`;
+                if (this.config.isSupportParseEnumDesc && schemaObject.description) {
+                    const enumMap = (0, util_1.parseDescriptionEnum)(schemaObject.description);
+                    enumLabelTypeStr = `{${(0, lodash_1.map)(enumArray, (value) => {
+                        const enumLabel = enumMap.get(Number(value));
+                        return `${Number(value)}:"${enumLabel}"`;
+                    }).join(',')}}`;
+                }
+                else {
+                    enumLabelTypeStr = `{${(0, lodash_1.map)(enumArray, (value) => `${Number(value)}:"NUMBER_${value}"`).join(',')}}`;
+                }
             }
             else if ((0, util_1.isAllNumeric)(enumArray)) {
-                enumLabelTypeStr = `{${(0, lodash_1.map)(enumArray, (value) => `"STRING_NUMBER_${value}":"${value}"`).join(',')}}`;
+                enumLabelTypeStr = `{${(0, lodash_1.map)(enumArray, (value) => `"${value}":"STRING_NUMBER_${value}"`).join(',')}}`;
             }
             else {
                 enumLabelTypeStr = `{${(0, lodash_1.map)(enumArray, (value) => `${value}:"${value}"`).join(',')}}`;

package/dist/generator/util.d.ts

@@ -22,3 +22,4 @@ export declare function resolveRefs(obj: OpenAPIObject, fields: string[]): unkno
 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>;

package/dist/generator/util.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseDescriptionEnum = void 0;
 exports.stripDot = stripDot;
 exports.resolveTypeName = resolveTypeName;
 exports.getRefName = getRefName;
@@ -343,3 +344,49 @@ function isAllNumber(arr) {
 function capitalizeFirstLetter(str) {
     return str.replace(/^[a-z]/, (match) => match.toUpperCase());
 }
+// 解析 description 中的枚举翻译
+const parseDescriptionEnum = (description) => {
+    const enumMap = new Map();
+    if (!description)
+        return enumMap;
+    // 首先处理可能的总体描述，例如 "系统用户角色:User=0,..."
+    let descToProcess = description;
+    const mainDescriptionMatch = description.match(/^([^:]+):(.*)/);
+    if (mainDescriptionMatch) {
+        // 如果有总体描述（如 "系统用户角色:"），只处理冒号后面的部分
+        descToProcess = mainDescriptionMatch[2];
+    }
+    // 匹配形如 "User(普通用户)=0" 或 "User=0" 的模式
+    const enumPattern = /([^():,=]+)(?:\(([^)]+)\))?=(\d+)/g;
+    let match;
+    while ((match = enumPattern.exec(descToProcess)) !== null) {
+        const name = match[1] ? match[1].trim() : '';
+        const valueStr = match[3] ? match[3].trim() : '';
+        if (valueStr && !isNaN(Number(valueStr))) {
+            // 统一使用英文key（如User）
+            enumMap.set(Number(valueStr), name);
+        }
+    }
+    // 如果没有匹配到任何枚举，尝试使用简单的分割方法作为后备
+    if (enumMap.size === 0) {
+        const pairs = descToProcess.split(',');
+        pairs.forEach((pair) => {
+            const parts = pair.split('=');
+            if (parts.length === 2) {
+                let label = parts[0].trim();
+                const value = parts[1].trim();
+                // 处理可能带有括号的情况
+                const bracketMatch = label.match(/([^(]+)\(([^)]+)\)/);
+                if (bracketMatch) {
+                    // 只使用括号前的英文key
+                    label = bracketMatch[1].trim();
+                }
+                if (label && value && !isNaN(Number(value))) {
+                    enumMap.set(Number(value), label);
+                }
+            }
+        });
+    }
+    return enumMap;
+};
+exports.parseDescriptionEnum = parseDescriptionEnum;

package/dist/index.d.ts

@@ -109,6 +109,10 @@ export type GenerateServiceProps = {
      * 模板文件、请求函数采用小驼峰命名
      */
     isCamelCase?: boolean;
+    /**
+     * 是否使用 description 中的枚举定义
+     */
+    isSupportParseEnumDesc?: boolean;
     /**
      * 命名空间名称，默认为API，不需要关注
      */
@@ -135,17 +139,17 @@ export type GenerateServiceProps = {
          * 自定义获取type hook
          * 返回非字符串将使用默认方法获取type
          * @example set number to string
-         * function customType(schemaObject,namespace){
+         * function customType({ schemaObject, namespace }){
          *  if(schemaObject.type==='number' && !schemaObject.format){
          *    return 'BigDecimalString';
          *  }
          * }
          */
-        customType?: ({ schemaObject, namespace, schemas, originGetType, }: {
+        customType?: ({ schemaObject, namespace, originGetType, schemas, }: {
             schemaObject: SchemaObject | ReferenceObject;
             namespace: string;
+            originGetType: (schemaObject: SchemaObject, namespace: string, schemas?: ComponentsObject['schemas']) => string;
             schemas?: ComponentsObject['schemas'];
-            originGetType: (schemaObject: SchemaObject, namespace: string) => string;
         }) => string;
         /**
          * 自定义生成文件名，可返回多个，表示生成多个文件;

package/dist/index.js

@@ -28,7 +28,7 @@ function generateService(_a) {
                     ? [/.*/g]
                     : null, excludeTags: excludeTags
                 ? (0, lodash_1.map)(excludeTags, (item) => typeof item === 'string' ? item.toLowerCase() : item)
-                : null, requestOptionsType: '{[key: string]: unknown}', namespace: 'API', isGenReactQuery: false, reactQueryMode, isGenJavaScript: false, isDisplayTypeLabel: false, isGenJsonSchemas: false, nullable: false, isOnlyGenTypeScriptType: false, isCamelCase: true }, rest), openAPI);
+                : null, requestOptionsType: '{[key: string]: unknown}', namespace: 'API', isGenReactQuery: false, reactQueryMode, isGenJavaScript: false, isDisplayTypeLabel: false, isGenJsonSchemas: false, nullable: false, isOnlyGenTypeScriptType: false, isCamelCase: true, isSupportParseEnumDesc: false }, rest), openAPI);
         serviceGenerator.genFile();
         if (mockFolder) {
             (0, mockGenarator_1.mockGenerator)({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-ts-request",
-  "version": "1.1.1",
+  "version": "1.2.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",
@@ -68,7 +68,7 @@
     "lint-staged": "^15.3.0",
     "openapi-types": "^12.1.3",
     "ts-node": "^10.9.2",
-    "typescript": "5.7.2"
+    "typescript": "5.7.3"
   },
   "keywords": [
     "openapi",

package/templates/displayEnumLabel.njk

@@ -3,7 +3,7 @@
 import * as {{ namespace }} from './{{ interfaceFileName }}';
 
 {% for type in list -%}
-export function {{ type.displayLabelFuncName }}(field: {{ namespace }}.I{{ type.typeName }}) {
+export function {{ type.displayLabelFuncName }}(field: {{ namespace }}.{{ type.typeName }}) {
   return ({{ type.enumLabelType }})[field]
 }
 

package/templates/reactQuery.njk

@@ -5,7 +5,8 @@
 import { queryOptions, useMutation } from '{{ reactQueryModePackageName }}';
 {%- if genType === "ts" %}
   import type { DefaultError } from '{{ reactQueryModePackageName }}';
-{% endif %}
+{% endif -%}
+{{ requestImportStatement }}
 
 import * as apis from './{{ className }}';
 {%- if genType === "ts" %}