openapi-ts-request 1.12.3 → 1.12.4

package/dist/generator/serviceGenarator.d.ts

@@ -9,6 +9,7 @@ export default class ServiceGenerator {
     protected schemaList: ISchemaItem[];
     protected interfaceTPConfigs: ITypeItem[];
     protected typeModuleMap: Map<string, Set<string>>;
+    protected schemaKeyToTypeNameMap: Map<string, string>;
     constructor(config: GenerateServiceProps, openAPIData: OpenAPIObject);
     genFile(): void;
     private getInterfaceTPConfigs;

package/dist/generator/serviceGenarator.js

@@ -26,6 +26,8 @@ class ServiceGenerator {
         this.interfaceTPConfigs = [];
         // 记录每个类型被哪些模块使用（用于拆分类型文件）
         this.typeModuleMap = new Map();
+        // 从原始 schema key 到最终类型名称的映射（用于处理重名情况）
+        this.schemaKeyToTypeNameMap = new Map();
         this.config = Object.assign({ templatesFolder: (0, path_1.join)(__dirname, '../../', 'templates') }, config);
         this.generateInfoLog();
         const includeTags = ((_a = this.config) === null || _a === void 0 ? void 0 : _a.includeTags) || [];
@@ -151,9 +153,12 @@ class ServiceGenerator {
         const isGenJavaScript = this.config.isGenJavaScript;
         const reactQueryMode = this.config.reactQueryMode;
         const reactQueryFileName = (0, config_2.displayReactQueryFileName)(reactQueryMode);
+        // 先处理重复的 typeName，建立类型名称映射（在生成 service controller 之前）
+        this.interfaceTPConfigs = this.getInterfaceTPConfigs();
+        this.schemaKeyToTypeNameMap = (0, util_2.handleDuplicateTypeNames)(this.interfaceTPConfigs);
         if (!isOnlyGenTypeScriptType) {
             const prettierError = [];
-            // 生成 service controller 文件
+            // 生成 service controller 文件（此时类型名称映射已经建立）
             this.getServiceTPConfigs().forEach((tp) => {
                 var _a, _b;
                 const { list } = tp, restTp = tslib_1.__rest(tp, ["list"]);
@@ -181,9 +186,6 @@ class ServiceGenerator {
                 (0, log_1.default)('🚥 格式化失败，请检查 service controller 文件内可能存在的语法错误');
             }
         }
-        // 处理重复的 typeName
-        this.interfaceTPConfigs = this.getInterfaceTPConfigs();
-        (0, util_2.handleDuplicateTypeNames)(this.interfaceTPConfigs);
         // 生成 ts 类型声明
         if (!isGenJavaScript) {
             if (this.config.isSplitTypesByModule) {
@@ -230,7 +232,8 @@ class ServiceGenerator {
                 });
             }
             else {
-                // 传统方式：所有类型在一个文件
+                // 在生成文件前，对 interfaceTPConfigs 进行排序（因为 getServiceTPConfigs 可能添加了新类型）
+                this.interfaceTPConfigs.sort((a, b) => a.typeName.localeCompare(b.typeName));
                 this.genFileFromTemplate(`${config_2.interfaceFileName}.ts`, config_2.TypescriptFileType.interface, {
                     nullable: this.config.nullable,
                     list: this.interfaceTPConfigs,
@@ -477,6 +480,7 @@ class ServiceGenerator {
                         : '',
                     enumLabelType: isEnum ? result.enumLabelType : '',
                     description: result.description,
+                    originalSchemaKey: schemaKey, // 保存原始 schema key，用于处理重名后的类型映射
                 });
                 // 记录 schema 类型归属
                 if (this.config.isSplitTypesByModule && schemaUsageMap.has(schemaKey)) {
@@ -495,7 +499,8 @@ class ServiceGenerator {
                 });
             }
         });
-        return lastTypes === null || lastTypes === void 0 ? void 0 : lastTypes.sort((a, b) => a.typeName.localeCompare(b.typeName)); // typeName排序
+        return lastTypes;
+        // return lastTypes?.sort((a, b) => a.typeName.localeCompare(b.typeName)); // typeName排序
     }
     getServiceTPConfigs() {
         return (0, lodash_1.keys)(this.apiData)
@@ -513,7 +518,7 @@ class ServiceGenerator {
             // 暂不支持变量, path 需要普通前缀请使用例如: apiPrefix: "`api`", path 需要变量前缀请使用例如: apiPrefix: "api"
             !api.path.includes('${'))
                 .map((api) => {
-                var _a, _b, _c, _d, _e, _f, _g, _h;
+                var _a, _b, _c, _d, _e;
                 const newApi = api;
                 try {
                     const params = this.getParamsTP(newApi.parameters, newApi.path) || {};
@@ -624,22 +629,36 @@ class ServiceGenerator {
                         // prefix 变量
                         return `$\{${prefix}}${formattedPath}`;
                     };
-                    return Object.assign(Object.assign({}, newApi), { functionName: this.config.isCamelCase
-                            ? (0, util_1.camelCase)(functionName)
-                            : functionName, typeName: this.getFunctionParamsTypeName(newApi), path: getPrefixPath(), pathInComment: formattedPath.replace(/\*/g, '*'), apifoxRunLink: newApi === null || newApi === void 0 ? void 0 : newApi['x-run-in-apifox'], hasPathVariables: formattedPath.includes('{'), hasApiPrefix: !!this.config.apiPrefix, method: newApi.method, 
-                        // 如果 functionName 和 summary 相同，则不显示 summary
-                        desc: functionName === newApi.summary
-                            ? (newApi.description || '').replace(config_2.lineBreakReg, '')
+                    return Object.assign(Object.assign(Object.assign({}, (() => {
+                        var _a, _b, _c;
+                        const rawDesc = functionName === newApi.summary
+                            ? newApi.description || ''
                             : [
                                 newApi.summary,
                                 newApi.description,
-                                ((_e = (_d = newApi.responses) === null || _d === void 0 ? void 0 : _d.default) === null || _e === void 0 ? void 0 : _e.description)
-                                    ? `返回值: ${((_f = newApi.responses) === null || _f === void 0 ? void 0 : _f.default).description}`
+                                ((_b = (_a = newApi.responses) === null || _a === void 0 ? void 0 : _a.default) === null || _b === void 0 ? void 0 : _b.description)
+                                    ? `返回值: ${((_c = newApi.responses) === null || _c === void 0 ? void 0 : _c.default).description}`
                                     : '',
                             ]
                                 .filter((s) => s)
-                                .join(' ')
-                                .replace(config_2.lineBreakReg, ''), hasHeader: !!(params === null || params === void 0 ? void 0 : params.header) || !!(body === null || body === void 0 ? void 0 : body.mediaType), params: finalParams, hasParams: Boolean((0, lodash_1.keys)(finalParams).length), options: ((_h = (_g = this.config.hook) === null || _g === void 0 ? void 0 : _g.customOptionsDefaultValue) === null || _h === void 0 ? void 0 : _h.call(_g, newApi)) || {}, body,
+                                .join(' ');
+                        const hasLineBreak = config_2.lineBreakReg.test(rawDesc);
+                        // 格式化描述文本，让描述支持换行
+                        const desc = hasLineBreak
+                            ? '\n * ' + rawDesc.split('\n').join('\n * ') + '\n *'
+                            : rawDesc;
+                        // 如果描述有换行，pathInComment 结尾加换行使 */ 单独一行
+                        const pathInComment = hasLineBreak
+                            ? formattedPath.replace(/\*/g, '*') + '\n'
+                            : formattedPath.replace(/\*/g, '*');
+                        const originApifoxRunLink = newApi === null || newApi === void 0 ? void 0 : newApi['x-run-in-apifox'];
+                        const apifoxRunLink = hasLineBreak && originApifoxRunLink
+                            ? ' * ' + originApifoxRunLink + '\n'
+                            : originApifoxRunLink;
+                        return { desc, pathInComment, apifoxRunLink };
+                    })()), newApi), { functionName: this.config.isCamelCase
+                            ? (0, util_1.camelCase)(functionName)
+                            : functionName, typeName: this.getFunctionParamsTypeName(newApi), path: getPrefixPath(), hasPathVariables: formattedPath.includes('{'), hasApiPrefix: !!this.config.apiPrefix, method: newApi.method, hasHeader: !!(params === null || params === void 0 ? void 0 : params.header) || !!(body === null || body === void 0 ? void 0 : body.mediaType), params: finalParams, hasParams: Boolean((0, lodash_1.keys)(finalParams).length), options: ((_e = (_d = this.config.hook) === null || _d === void 0 ? void 0 : _d.customOptionsDefaultValue) === null || _e === void 0 ? void 0 : _e.call(_d, newApi)) || {}, body,
                         file, hasFormData: formData, response });
                 }
                 catch (error) {
@@ -779,18 +798,21 @@ class ServiceGenerator {
         var _a, _b;
         const customTypeHookFunc = (_a = this.config.hook) === null || _a === void 0 ? void 0 : _a.customType;
         const schemas = (_b = this.openAPIData.components) === null || _b === void 0 ? void 0 : _b.schemas;
+        const schemaKeyToTypeNameMap = this.schemaKeyToTypeNameMap;
         if (customTypeHookFunc) {
+            // 为自定义 hook 提供支持映射的 originGetType
+            const originGetTypeWithMapping = (schema, ns, s) => (0, util_2.getDefaultType)(schema, ns, s, schemaKeyToTypeNameMap);
             const type = customTypeHookFunc({
                 schemaObject,
                 namespace,
                 schemas,
-                originGetType: util_2.getDefaultType,
+                originGetType: originGetTypeWithMapping,
             });
             if (typeof type === 'string') {
                 return type;
             }
         }
-        return (0, util_2.getDefaultType)(schemaObject, namespace, schemas);
+        return (0, util_2.getDefaultType)(schemaObject, namespace, schemas, schemaKeyToTypeNameMap);
     }
     getFunctionParamsTypeName(data) {
         var _a, _b, _c;
@@ -1153,6 +1175,13 @@ class ServiceGenerator {
         });
         // 处理公共类型的依赖：如果公共类型依赖某个模块类型，将该类型也移到公共类型
         Helper.moveCommonTypeDependenciesToCommon({ moduleTypes, commonTypes });
+        // 对每个模块的类型列表进行排序
+        moduleTypes.forEach((types) => {
+            types.sort((a, b) => a.typeName.localeCompare(b.typeName));
+        });
+        // 对公共类型和枚举类型进行排序
+        commonTypes.sort((a, b) => a.typeName.localeCompare(b.typeName));
+        enumTypes.sort((a, b) => a.typeName.localeCompare(b.typeName));
         return { moduleTypes, commonTypes, enumTypes };
     }
 }

package/dist/generator/serviceGeneratorHelper.js

@@ -126,11 +126,15 @@ function resolveEnumObject(params) {
             enumLabelTypeStr = `{${(0, lodash_1.map)(enumArray, (value) => `"${value}":"${value}"`).join(',')}}`;
         }
     }
+    // 格式化描述文本，让描述支持换行
+    const formattedDescription = schemaObject.description && config_2.lineBreakReg.test(schemaObject.description)
+        ? '\n * ' + schemaObject.description.split('\n').join('\n * ') + '\n'
+        : schemaObject.description;
     return {
         isEnum: true,
         type: Array.isArray(enumArray) ? enumStr : 'string',
         enumLabelType: enumLabelTypeStr,
-        description: schemaObject.description,
+        description: formattedDescription,
     };
 }
 /**
@@ -166,17 +170,23 @@ function getProps(params) {
         // 获取描述信息，如果是 $ref 引用，尝试获取引用对象的描述
         let desc = [schema.title, schema.description]
             .filter((item) => item)
-            .join(' ')
-            .replace(config_2.lineBreakReg, '');
+            .join(' ');
+        // 格式化描述文本，让描述支持换行
+        desc = config_2.lineBreakReg.test(desc)
+            ? '\n * ' + desc.split('\n').join('\n * ') + '\n'
+            : desc;
         // 如果是 $ref 引用，尝试获取引用对象的描述
         if ((0, util_1.isReferenceObject)(schema) && openAPIData) {
             const refName = (0, util_1.getLastRefName)(schema.$ref);
             const refSchema = (_b = (_a = openAPIData.components) === null || _a === void 0 ? void 0 : _a.schemas) === null || _b === void 0 ? void 0 : _b[refName];
             if (refSchema) {
-                const refDesc = [refSchema.title, refSchema.description]
+                let refDesc = [refSchema.title, refSchema.description]
                     .filter((item) => item)
-                    .join(' ')
-                    .replace(config_2.lineBreakReg, '');
+                    .join(' ');
+                // 格式化描述文本，让描述支持换行
+                refDesc = config_2.lineBreakReg.test(refDesc)
+                    ? '\n * ' + refDesc.split('\n').join('\n * ') + '\n'
+                    : refDesc;
                 if (refDesc) {
                     desc = desc + refDesc;
                 }
@@ -237,7 +247,9 @@ function resolveRefObject(params) {
             // 处理 OpenAPI 3.1 的 type 数组情况
             if (Array.isArray(schemaObj.type)) {
                 // 如果是数组，使用第一个非 null 类型
-                resolvedType = schemaObj.type.find((t) => t !== 'null') || 'string';
+                resolvedType =
+                    schemaObj.type.find((t) => t !== 'null') ||
+                        'string';
             }
             else {
                 resolvedType = schemaObj.type;
@@ -276,7 +288,7 @@ function getResponsesType(params) {
             : description;
         // 生成带注释的类型定义
         return formattedDescription
-            ? `  /**\n   * ${formattedDescription}\n   */\n  ${statusCode}: ${lastType};`
+            ? `  /**\n * ${formattedDescription}\n */\n ${statusCode}: ${lastType};`
             : `  ${statusCode}: ${lastType};`;
     });
     // 返回完整的对象类型定义

package/dist/generator/type.d.ts

@@ -29,6 +29,8 @@ export interface ITypeItem {
     description?: string;
     /** 类型所属的模块名称（用于拆分类型文件） */
     belongsToModules?: Set<string>;
+    /** 原始的 schema key（用于处理重名后的类型映射） */
+    originalSchemaKey?: string;
 }
 export type ICustomSchemaObject = SchemaObject & {
     isAllowed?: boolean;

package/dist/generator/util.d.ts

@@ -3,10 +3,17 @@ import type { ITypeItem } from './type';
 export declare function stripDot(str: string): string;
 export declare function resolveTypeName(typeName: string): string;
 export declare function getRefName(refObject: ReferenceObject | string): string;
+/**
+ * 获取引用类型名称，支持类型名称映射
+ * @param refObject 引用对象
+ * @param schemaKeyToTypeNameMap 从原始 schema key 到最终类型名称的映射（处理重名情况）
+ * @returns 最终的类型名称
+ */
+export declare function getRefNameWithMapping(refObject: ReferenceObject | string, schemaKeyToTypeNameMap?: Map<string, string>): string;
 export declare function getLastRefName(refPath?: string): string;
-export declare function getDefaultType(schemaObject?: ISchemaObject | string, namespace?: string, schemas?: ComponentsObject['schemas']): string;
+export declare function getDefaultType(schemaObject?: ISchemaObject | string, namespace?: string, schemas?: ComponentsObject['schemas'], schemaKeyToTypeNameMap?: Map<string, string>): string;
 export declare function getDefaultFileTag(operationObject: OperationObject, apiPath: string): string[];
-export declare function handleDuplicateTypeNames(interfaceTPConfigs: Array<Pick<ITypeItem, 'typeName' | 'displayLabelFuncName'>>): void;
+export declare function handleDuplicateTypeNames(interfaceTPConfigs: Array<Pick<ITypeItem, 'typeName' | 'displayLabelFuncName' | 'originalSchemaKey'>>): Map<string, string>;
 export declare function getBasePrefix(paths: string[]): string;
 export declare function genDefaultFunctionName(path: string, pathBasePrefix: string): string;
 export declare function getFinalFileName(s: string): string;

package/dist/generator/util.js

@@ -4,6 +4,7 @@ exports.getAxiosResponseType = exports.getBinaryResponseType = exports.isBinaryM
 exports.stripDot = stripDot;
 exports.resolveTypeName = resolveTypeName;
 exports.getRefName = getRefName;
+exports.getRefNameWithMapping = getRefNameWithMapping;
 exports.getLastRefName = getLastRefName;
 exports.getDefaultType = getDefaultType;
 exports.getDefaultFileTag = getDefaultFileTag;
@@ -83,13 +84,31 @@ function getRefName(refObject) {
     }
     return resolveTypeName(getLastRefName(refObject.$ref));
 }
+/**
+ * 获取引用类型名称，支持类型名称映射
+ * @param refObject 引用对象
+ * @param schemaKeyToTypeNameMap 从原始 schema key 到最终类型名称的映射（处理重名情况）
+ * @returns 最终的类型名称
+ */
+function getRefNameWithMapping(refObject, schemaKeyToTypeNameMap) {
+    if (!isReferenceObject(refObject)) {
+        return refObject;
+    }
+    const schemaKey = getLastRefName(refObject.$ref);
+    // 如果存在映射，使用映射后的类型名称
+    if (schemaKeyToTypeNameMap === null || schemaKeyToTypeNameMap === void 0 ? void 0 : schemaKeyToTypeNameMap.has(schemaKey)) {
+        return schemaKeyToTypeNameMap.get(schemaKey);
+    }
+    // 否则使用默认的类型名称解析
+    return resolveTypeName(schemaKey);
+}
 function getLastRefName(refPath = '') {
     const refPaths = refPath.split('/');
     return refPaths.length > 0
         ? decodeURIComponent(refPaths[refPaths.length - 1])
         : '';
 }
-function getDefaultType(schemaObject, namespace = '', schemas) {
+function getDefaultType(schemaObject, namespace = '', schemas, schemaKeyToTypeNameMap) {
     var _a, _b;
     if ((0, lodash_1.isUndefined)(schemaObject) || (0, lodash_1.isNull)(schemaObject)) {
         return 'unknown';
@@ -98,8 +117,9 @@ function getDefaultType(schemaObject, namespace = '', schemas) {
         return schemaObject;
     }
     if (isReferenceObject(schemaObject)) {
-        // return getRefName(schemaObject);
-        return [namespace, getRefName(schemaObject)].filter((s) => s).join('.');
+        // 使用映射获取正确的类型名称（处理重名情况）
+        const refName = getRefNameWithMapping(schemaObject, schemaKeyToTypeNameMap);
+        return [namespace, refName].filter((s) => s).join('.');
     }
     let type = schemaObject === null || schemaObject === void 0 ? void 0 : schemaObject.type;
     const dateEnum = ['Date', 'date', 'dateTime', 'date-time', 'datetime'];
@@ -142,11 +162,11 @@ function getDefaultType(schemaObject, namespace = '', schemas) {
         }
         if (Array.isArray(items)) {
             const arrayItemType = items
-                .map((subType) => getDefaultType((subType.schema || subType), namespace))
+                .map((subType) => getDefaultType((subType.schema || subType), namespace, schemas, schemaKeyToTypeNameMap))
                 .toString();
             return `[${arrayItemType}]`;
         }
-        const arrayType = getDefaultType(items, namespace);
+        const arrayType = getDefaultType(items, namespace, schemas, schemaKeyToTypeNameMap);
         return arrayType.includes(' | ') ? `(${arrayType})[]` : `${arrayType}[]`;
     }
     if (type === 'enum') {
@@ -158,12 +178,12 @@ function getDefaultType(schemaObject, namespace = '', schemas) {
     }
     if (schemaObject.oneOf && schemaObject.oneOf.length) {
         return schemaObject.oneOf
-            .map((item) => getDefaultType(item, namespace))
+            .map((item) => getDefaultType(item, namespace, schemas, schemaKeyToTypeNameMap))
             .join(' | ');
     }
     if ((_a = schemaObject.anyOf) === null || _a === void 0 ? void 0 : _a.length) {
         return schemaObject.anyOf
-            .map((item) => getDefaultType(item, namespace))
+            .map((item) => getDefaultType(item, namespace, schemas, schemaKeyToTypeNameMap))
             .join(' | ');
     }
     if ((_b = schemaObject.allOf) === null || _b === void 0 ? void 0 : _b.length) {
@@ -173,17 +193,16 @@ function getDefaultType(schemaObject, namespace = '', schemas) {
                 // 不使用 getRefName 函数处理，无法通过 schemas[schemaKey] 获取到schema
                 const schemaKey = getLastRefName(item.$ref);
                 if ((_a = schemas === null || schemas === void 0 ? void 0 : schemas[schemaKey]) === null || _a === void 0 ? void 0 : _a.enum) {
-                    // return `I${getDefaultType(item, namespace)}`;
-                    return getDefaultType(item, namespace);
+                    return getDefaultType(item, namespace, schemas, schemaKeyToTypeNameMap);
                 }
             }
-            return getDefaultType(item, namespace);
+            return getDefaultType(item, namespace, schemas, schemaKeyToTypeNameMap);
         });
         return `(${allofList.join(' & ')})`;
     }
     if (schemaObject.type === 'object' || schemaObject.properties) {
         if ((0, lodash_1.isObject)(schemaObject.additionalProperties)) {
-            const type = getDefaultType(schemaObject.additionalProperties, namespace, schemas);
+            const type = getDefaultType(schemaObject.additionalProperties, namespace, schemas, schemaKeyToTypeNameMap);
             return `Record<string, ${type}>`;
         }
         if (!(0, lodash_1.keys)(schemaObject.properties).length) {
@@ -211,7 +230,7 @@ function getDefaultType(schemaObject, namespace = '', schemas) {
              * 错误的继续保留字符串。
              * */
             return `
-        ${property.description ? `/** ${property.description} */\n` : ''}'${key}'${required ? '' : '?'}: ${getDefaultType(property, namespace)}; `;
+        ${property.description ? `/** ${property.description} */\n` : ''}'${key}'${required ? '' : '?'}: ${getDefaultType(property, namespace, schemas, schemaKeyToTypeNameMap)}; `;
         })
             .join('')}}`;
     }
@@ -239,6 +258,8 @@ function findDuplicateTypeNames(arr) {
     return duplicates;
 }
 function handleDuplicateTypeNames(interfaceTPConfigs) {
+    // 创建从原始 schema key 到最终类型名称的映射
+    const schemaKeyToTypeNameMap = new Map();
     const duplicateTypeNames = findDuplicateTypeNames((0, lodash_1.map)(interfaceTPConfigs, (item) => item.typeName));
     if (!(0, lodash_1.isEmpty)(duplicateTypeNames)) {
         (0, lodash_1.forEach)(duplicateTypeNames, (typeName) => {
@@ -253,6 +274,13 @@ function handleDuplicateTypeNames(interfaceTPConfigs) {
             });
         });
     }
+    // 建立映射关系（在处理重名之后）
+    (0, lodash_1.forEach)(interfaceTPConfigs, (interfaceTP) => {
+        if (interfaceTP.originalSchemaKey) {
+            schemaKeyToTypeNameMap.set(interfaceTP.originalSchemaKey, interfaceTP.typeName);
+        }
+    });
+    return schemaKeyToTypeNameMap;
 }
 // 检测所有path重复区域（prefix）
 function getBasePrefix(paths) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-ts-request",
-  "version": "1.12.3",
+  "version": "1.12.4",
   "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",