openapi-ts-request 1.10.1 → 1.12.0

package/README.md

@@ -187,6 +187,7 @@ $ openapi --help
     -cfn, --configFileName <string>     config file name
     -cfp, --configFilePath <string>     config file path
     --requestLibPath <string>           custom request lib path, for example: "@/request", "node-fetch" (default: "axios")
+    --isSplitTypesByModule <boolean>      split types by module, generates {module}.type.ts, common.type.ts, enum.ts, types.ts (default: false)
     -f, --full <boolean>                full replacement (default: true)
     --enableLogging <boolean>           open the log (default: false)
     --priorityRule <string>             priority rule, include/exclude/both (default: "include")
@@ -210,6 +211,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
 ```
 
@@ -226,6 +228,7 @@ openapi --i ./spec.json --o ./apis
 | schemaPath | 是 | string | - | Swagger2/OpenAPI3 地址 |
 | serversPath | 否 | string | './src/apis' | 运行结果文件夹路径 |
 | requestLibPath | 否 | string | 'axios' | 自定义请求方法路径，例如：'@/request'、'node-fetch' |
+| isSplitTypesByModule | 否 | boolean | false | 按模块拆分类型文件，开启后会生成：{module}.type.ts（各模块类型）、common.type.ts（公共类型）、enum.ts（枚举类型）、types.ts（统一导出） |
 | full | 否 | boolean | true | 是否全量替换 |
 | describe | 否 | string | - | 描述信息，在用 cli 可交互运行方式时会用到 |
 | enableLogging | 否 | boolean | false | 是否开启日志 |
@@ -251,6 +254,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/openapi.js

@@ -19,6 +19,7 @@ const params = commander_1.program
     .option('-cfn, --configFileName <string>', 'config file name')
     .option('-cfp, --configFilePath <string>', 'config file path')
     .option('--requestLibPath <string>', 'custom request lib path, for example: "@/request", "node-fetch" (default: "axios")')
+    .option('--isSplitTypesByModule <boolean>', 'split types by module, generates {module}.type.ts, common.type.ts, enum.ts, types.ts', false)
     .option('-f, --full <boolean>', 'full replacement', true)
     .option('--enableLogging <boolean>', 'open the log', false)
     .option('--priorityRule <string>', 'priority rule, include/exclude/both (default: "include")')
@@ -42,6 +43,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) {
@@ -80,6 +82,8 @@ const baseGenerate = (_params_) => {
         isOnlyGenTypeScriptType: JSON.parse(_params_.isOnlyGenTypeScriptType) === true,
         isCamelCase: JSON.parse(_params_.isCamelCase) === true,
         isSupportParseEnumDesc: JSON.parse(_params_.isSupportParseEnumDesc) === true,
+        supportParseEnumDescByReg: _params_.supportParseEnumDescByReg,
+        isSplitTypesByModule: JSON.parse(_params_.isSplitTypesByModule) === true,
     };
     return options;
 };

package/dist/generator/config.d.ts

@@ -5,6 +5,8 @@ export declare const interfaceFileName = "types";
 export declare const displayEnumLabelFileName = "displayEnumLabel";
 export declare const displayTypeLabelFileName = "displayTypeLabel";
 export declare const schemaFileName = "schema";
+export declare const enumFileName = "enum";
+export declare const commonTypeFileName = "common.type";
 export declare const displayReactQueryFileName: (reactQueryMode: IReactQueryMode) => string;
 export declare enum TypescriptFileType {
     interface = "interface",
@@ -13,7 +15,10 @@ export declare enum TypescriptFileType {
     displayEnumLabel = "displayEnumLabel",
     displayTypeLabel = "displayTypeLabel",
     schema = "schema",
-    reactQuery = "reactQuery"
+    reactQuery = "reactQuery",
+    moduleType = "moduleType",
+    typeIndex = "typeIndex",
+    enum = "enum"
 }
 export declare const DEFAULT_SCHEMA: SchemaObject;
 export declare const DEFAULT_PATH_PARAM: ParameterObject & Dictionary<unknown>;

package/dist/generator/config.js

@@ -1,11 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LangType = exports.lineBreakReg = exports.numberEnum = exports.parametersIn = exports.parametersInsEnum = exports.methods = exports.DEFAULT_PATH_PARAM = exports.DEFAULT_SCHEMA = exports.TypescriptFileType = exports.displayReactQueryFileName = exports.schemaFileName = exports.displayTypeLabelFileName = exports.displayEnumLabelFileName = exports.interfaceFileName = exports.serviceEntryFileName = void 0;
+exports.LangType = exports.lineBreakReg = exports.numberEnum = exports.parametersIn = exports.parametersInsEnum = exports.methods = exports.DEFAULT_PATH_PARAM = exports.DEFAULT_SCHEMA = exports.TypescriptFileType = exports.displayReactQueryFileName = exports.commonTypeFileName = exports.enumFileName = exports.schemaFileName = exports.displayTypeLabelFileName = exports.displayEnumLabelFileName = exports.interfaceFileName = exports.serviceEntryFileName = void 0;
 exports.serviceEntryFileName = 'index';
 exports.interfaceFileName = 'types';
 exports.displayEnumLabelFileName = 'displayEnumLabel';
 exports.displayTypeLabelFileName = 'displayTypeLabel';
 exports.schemaFileName = 'schema';
+exports.enumFileName = 'enum';
+exports.commonTypeFileName = 'common.type';
 const displayReactQueryFileName = (reactQueryMode) => {
     return {
         react: 'reactquery',
@@ -22,6 +24,9 @@ var TypescriptFileType;
     TypescriptFileType["displayTypeLabel"] = "displayTypeLabel";
     TypescriptFileType["schema"] = "schema";
     TypescriptFileType["reactQuery"] = "reactQuery";
+    TypescriptFileType["moduleType"] = "moduleType";
+    TypescriptFileType["typeIndex"] = "typeIndex";
+    TypescriptFileType["enum"] = "enum";
 })(TypescriptFileType || (exports.TypescriptFileType = TypescriptFileType = {}));
 exports.DEFAULT_SCHEMA = {
     type: 'object',

package/dist/generator/serviceGenarator.d.ts

@@ -8,6 +8,7 @@ export default class ServiceGenerator {
     protected openAPIData: OpenAPIObject;
     protected schemaList: ISchemaItem[];
     protected interfaceTPConfigs: ITypeItem[];
+    protected typeModuleMap: Map<string, Set<string>>;
     constructor(config: GenerateServiceProps, openAPIData: OpenAPIObject);
     genFile(): void;
     private getInterfaceTPConfigs;
@@ -31,14 +32,6 @@ export default class ServiceGenerator {
      * @returns 多状态码响应类型定义字符串，如果没有响应则返回 null
      */
     private getResponsesType;
-    /**
-     * 解析响应条目，提取每个状态码对应的类型和描述信息
-     *
-     * @param responses OpenAPI 响应对象
-     * @param components OpenAPI 组件对象，用于解析引用类型
-     * @returns 响应条目数组，包含状态码、类型和描述
-     */
-    private parseResponseEntries;
     /**
      * 从响应内容中提取 TypeScript 类型
      * 处理不同的媒体类型和 schema 类型
@@ -71,4 +64,23 @@ export default class ServiceGenerator {
      * @param reg 规则
      */
     private matches;
+    /**
+     * 记录类型被某个模块使用
+     * @param typeName 类型名称
+     * @param moduleName 模块名称
+     */
+    private markTypeUsedByModule;
+    /**
+     * 获取模块需要导入的类型
+     * @param moduleTypes 模块类型列表
+     * @param commonTypes 公共类型列表
+     * @param enumTypes 枚举类型列表
+     * @returns 导入信息
+     */
+    private getModuleImports;
+    /**
+     * 分组类型：按模块、公共类型和枚举
+     * @returns 分组后的类型
+     */
+    private groupTypesByModule;
 }