openapi-ts-request 1.0.1 → 1.1.0

package/README.md

@@ -10,7 +10,7 @@
 - 客户端请求函数(支持任意客户端)
 - 模拟请求响应服务
 - 枚举和枚举翻译
-- react-query
+- react-query/vue-query
 - 类型字段翻译
 - JSON Schemas
 
@@ -19,7 +19,7 @@
 ## 功能
 
 - 支持 Swagger2.0/OpenAPI/Apifox 3.0,3.1 定义
-- 生成 TypeScript/JavaScript, 请求客户端(支持任意客户端), 请求模拟服务, 枚举和枚举翻译, react-query, 类型字段翻译, JSON Schemas
+- 生成 TypeScript/JavaScript, 请求客户端(支持任意客户端), 请求模拟服务, 枚举和枚举翻译, react-query/vue-query, 类型字段翻译, JSON Schemas
 - 支持通过 npx、CLI、Nodejs 的方式使用
 - 支持自定义请求工具函数, 支持 Fetch、Axios、[UniApp-Request](https://github.com/openapi-ui/openapi-ts-request/issues/46)、Taro-Request、Node.js、XHR 客户端
 - 支持通过 tags 过滤生成结果
@@ -195,6 +195,7 @@ $ openapi --help
     --requestImportStatement <string>   custom request import statement, for example: "const request = require('@/request')"
     --apiPrefix <string>                custom the prefix of the api path, for example: "api"(variable), "'api'"(string)
     --isGenReactQuery <boolean>         generate react-query (default: false)
+    --reactQueryMode <string>           react-query mode, react/vue (default: "react")
     --isGenJavaScript <boolean>         generate JavaScript (default: false)
     --isDisplayTypeLabel <boolean>      generate label matching type field (default: false)
     --isGenJsonSchemas <boolean>        generate JSON Schemas (default: false)
@@ -230,6 +231,7 @@ openapi --i ./spec.json --o ./apis
 | requestImportStatement | 否 | string | - | 自定义请求方法表达式，例如："const request = require('@/request')" |
 | apiPrefix | 否 | string | - | api path的前缀，例如：'api'(动态变量), "'api'"(字符串) |
 | isGenReactQuery | 否 | boolean | false | 是否生成 react-query |
+| reactQueryMode | 否 | string | 'react' | react-query 模式，可选 react/vue |
 | isGenJavaScript | 否 | boolean | false | 是否生成 JavaScript |
 | isDisplayTypeLabel | 否 | boolean | false | 是否生成 type 对应的label |
 | isGenJsonSchemas | 否 | boolean | false | 是否生成 JSON Schemas |

package/dist/bin/openapi.js

@@ -24,6 +24,7 @@ const params = commander_1.program
     .option('--requestImportStatement <string>', `custom request import statement, for example: "const request = require('@/request')"`)
     .option('--apiPrefix <string>', `custom the prefix of the api path, for example: "api"(variable), "'api'"(string)`)
     .option('--isGenReactQuery <boolean>', 'generate react-query', false)
+    .option('--reactQueryMode <string>', 'react-query mode, react/vue (default: "react")')
     .option('--isGenJavaScript <boolean>', 'generate JavaScript', false)
     .option('--isDisplayTypeLabel <boolean>', 'generate label matching type field', false)
     .option('--isGenJsonSchemas <boolean>', 'generate JSON Schemas', false)
@@ -60,6 +61,7 @@ function run() {
                 requestOptionsType: params.requestOptionsType,
                 apiPrefix: params.apiPrefix,
                 isGenReactQuery: JSON.parse(params.isGenReactQuery) === true,
+                reactQueryMode: params.reactQueryMode,
                 isGenJavaScript: JSON.parse(params.isGenJavaScript) === true,
                 isDisplayTypeLabel: JSON.parse(params.isDisplayTypeLabel) === true,
                 isGenJsonSchemas: JSON.parse(params.isGenJsonSchemas) === true,

package/dist/config.d.ts

@@ -0,0 +1,36 @@
+import { IReactQueryMode } from './type';
+export declare enum SchemaObjectFormat {
+    int32 = "int32",
+    int64 = "int64",
+    float = "float",
+    double = "double",
+    byte = "byte",
+    binary = "binary",
+    date = "date",
+    dateTime = "date-time",
+    password = "password",
+    base64 = "base64"
+}
+export declare enum SchemaObjectType {
+    array = "array",
+    stringArray = "string[]",
+    boolean = "boolean",
+    object = "object",
+    number = "number",
+    string = "string",
+    integer = "integer",
+    enum = "enum",
+    null = "null",
+    union = "union",
+    file = "file"
+}
+export declare enum PriorityRule {
+    include = "include",
+    exclude = "exclude",
+    both = "both"
+}
+export declare enum ReactQueryMode {
+    react = "react",
+    vue = "vue"
+}
+export declare const displayReactQueryMode: (mode: IReactQueryMode) => string;

package/dist/config.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.displayReactQueryMode = exports.ReactQueryMode = exports.PriorityRule = exports.SchemaObjectType = exports.SchemaObjectFormat = void 0;
+var SchemaObjectFormat;
+(function (SchemaObjectFormat) {
+    SchemaObjectFormat["int32"] = "int32";
+    SchemaObjectFormat["int64"] = "int64";
+    SchemaObjectFormat["float"] = "float";
+    SchemaObjectFormat["double"] = "double";
+    SchemaObjectFormat["byte"] = "byte";
+    SchemaObjectFormat["binary"] = "binary";
+    SchemaObjectFormat["date"] = "date";
+    SchemaObjectFormat["dateTime"] = "date-time";
+    SchemaObjectFormat["password"] = "password";
+    SchemaObjectFormat["base64"] = "base64";
+})(SchemaObjectFormat || (exports.SchemaObjectFormat = SchemaObjectFormat = {}));
+var SchemaObjectType;
+(function (SchemaObjectType) {
+    SchemaObjectType["array"] = "array";
+    SchemaObjectType["stringArray"] = "string[]";
+    SchemaObjectType["boolean"] = "boolean";
+    SchemaObjectType["object"] = "object";
+    SchemaObjectType["number"] = "number";
+    SchemaObjectType["string"] = "string";
+    SchemaObjectType["integer"] = "integer";
+    SchemaObjectType["enum"] = "enum";
+    SchemaObjectType["null"] = "null";
+    SchemaObjectType["union"] = "union";
+    SchemaObjectType["file"] = "file";
+})(SchemaObjectType || (exports.SchemaObjectType = SchemaObjectType = {}));
+var PriorityRule;
+(function (PriorityRule) {
+    PriorityRule["include"] = "include";
+    PriorityRule["exclude"] = "exclude";
+    PriorityRule["both"] = "both";
+})(PriorityRule || (exports.PriorityRule = PriorityRule = {}));
+var ReactQueryMode;
+(function (ReactQueryMode) {
+    ReactQueryMode["react"] = "react";
+    ReactQueryMode["vue"] = "vue";
+})(ReactQueryMode || (exports.ReactQueryMode = ReactQueryMode = {}));
+const displayReactQueryMode = (mode) => {
+    return {
+        react: '@tanstack/react-query',
+        vue: '@tanstack/vue-query',
+    }[mode];
+};
+exports.displayReactQueryMode = displayReactQueryMode;

package/dist/generator/config.d.ts

@@ -1,11 +1,11 @@
 import { Dictionary } from 'lodash';
-import { ParameterObject, SchemaObject } from '../type';
+import { IReactQueryMode, ParameterObject, SchemaObject } from '../type';
 export declare const serviceEntryFileName = "index";
 export declare const interfaceFileName = "types";
 export declare const displayEnumLabelFileName = "displayEnumLabel";
 export declare const displayTypeLabelFileName = "displayTypeLabel";
 export declare const schemaFileName = "schema";
-export declare const reactQueryFileName = "reactquery";
+export declare const displayReactQueryFileName: (reactQueryMode: IReactQueryMode) => string;
 export declare enum TypescriptFileType {
     interface = "interface",
     serviceController = "serviceController",

package/dist/generator/config.js

@@ -1,12 +1,18 @@
 "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.reactQueryFileName = 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.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.reactQueryFileName = 'reactquery';
+const displayReactQueryFileName = (reactQueryMode) => {
+    return {
+        react: 'reactquery',
+        vue: 'vuequery',
+    }[reactQueryMode];
+};
+exports.displayReactQueryFileName = displayReactQueryFileName;
 var TypescriptFileType;
 (function (TypescriptFileType) {
     TypescriptFileType["interface"] = "interface";

package/dist/generator/serviceGenarator.js

@@ -8,9 +8,9 @@ const minimatch_1 = require("minimatch");
 const nunjucks_1 = tslib_1.__importDefault(require("nunjucks"));
 const path_1 = require("path");
 const rimraf_1 = require("rimraf");
+const config_1 = require("../config");
 const log_1 = tslib_1.__importDefault(require("../log"));
-const type_1 = require("../type");
-const config_1 = require("./config");
+const config_2 = require("./config");
 const file_1 = require("./file");
 const patchSchema_1 = require("./patchSchema");
 const util_1 = require("./util");
@@ -26,7 +26,7 @@ class ServiceGenerator {
         const includePaths = ((_b = this.config) === null || _b === void 0 ? void 0 : _b.includePaths) || [];
         const excludeTags = ((_c = this.config) === null || _c === void 0 ? void 0 : _c.excludeTags) || [];
         const excludePaths = ((_d = this.config) === null || _d === void 0 ? void 0 : _d.excludePaths) || [];
-        const priorityRule = type_1.PriorityRule[config.priorityRule];
+        const priorityRule = config_1.PriorityRule[config.priorityRule];
         if ((_e = this.config.hook) === null || _e === void 0 ? void 0 : _e.afterOpenApiDataInited) {
             this.openAPIData =
                 this.config.hook.afterOpenApiDataInited(openAPIData) || openAPIData;
@@ -38,7 +38,7 @@ class ServiceGenerator {
         outerLoop: for (const pathKey in this.openAPIData.paths) {
             // 这里判断paths
             switch (priorityRule) {
-                case type_1.PriorityRule.include: {
+                case config_1.PriorityRule.include: {
                     // includePaths and includeTags is empty, 直接跳过
                     if ((0, lodash_1.isEmpty)(includeTags) && (0, lodash_1.isEmpty)(includePaths)) {
                         this.log('priorityRule include need includeTags or includePaths');
@@ -50,13 +50,13 @@ class ServiceGenerator {
                     }
                     break;
                 }
-                case type_1.PriorityRule.exclude: {
+                case config_1.PriorityRule.exclude: {
                     if (this.validateRegexp(pathKey, excludePaths)) {
                         continue;
                     }
                     break;
                 }
-                case type_1.PriorityRule.both: {
+                case config_1.PriorityRule.both: {
                     // includePaths and includeTags is empty，直接跳过
                     if ((0, lodash_1.isEmpty)(includeTags) && (0, lodash_1.isEmpty)(includePaths)) {
                         this.log('priorityRule both need includeTags or includePaths');
@@ -75,7 +75,7 @@ class ServiceGenerator {
                     throw new Error('priorityRule must be "include" or "exclude" or "include"');
             }
             const pathItem = this.openAPIData.paths[pathKey];
-            (0, lodash_1.forEach)(config_1.methods, (method) => {
+            (0, lodash_1.forEach)(config_2.methods, (method) => {
                 var _a;
                 const operationObject = pathItem[method];
                 if (!operationObject) {
@@ -89,7 +89,7 @@ class ServiceGenerator {
                         return;
                     }
                     const tagLowerCase = tag.toLowerCase();
-                    if (priorityRule === type_1.PriorityRule.include) {
+                    if (priorityRule === config_1.PriorityRule.include) {
                         // includeTags 为空，不会匹配任何path，故跳过
                         if ((0, lodash_1.isEmpty)(includeTags)) {
                             this.log('priorityRule include need includeTags or includePaths');
@@ -99,12 +99,12 @@ class ServiceGenerator {
                             return;
                         }
                     }
-                    if (priorityRule === type_1.PriorityRule.exclude) {
+                    if (priorityRule === config_1.PriorityRule.exclude) {
                         if (this.validateRegexp(tagLowerCase, excludeTags)) {
                             return;
                         }
                     }
-                    if (priorityRule === type_1.PriorityRule.both) {
+                    if (priorityRule === config_1.PriorityRule.both) {
                         // includeTags is empty 没有配置, 直接跳过
                         if ((0, lodash_1.isEmpty)(includeTags)) {
                             this.log('priorityRule both need includeTags or includePaths');
@@ -142,12 +142,14 @@ class ServiceGenerator {
         }
         const isOnlyGenTypeScriptType = this.config.isOnlyGenTypeScriptType;
         const isGenJavaScript = this.config.isGenJavaScript;
+        const reactQueryMode = this.config.reactQueryMode;
+        const reactQueryFileName = (0, config_2.displayReactQueryFileName)(reactQueryMode);
         // 处理重复的 typeName
         const interfaceTPConfigs = this.getInterfaceTPConfigs();
         (0, util_1.handleDuplicateTypeNames)(interfaceTPConfigs);
         // 生成 ts 类型声明
         if (!isGenJavaScript) {
-            this.genFileFromTemplate(`${config_1.interfaceFileName}.ts`, config_1.TypescriptFileType.interface, {
+            this.genFileFromTemplate(`${config_2.interfaceFileName}.ts`, config_2.TypescriptFileType.interface, {
                 nullable: this.config.nullable,
                 list: interfaceTPConfigs,
             });
@@ -155,10 +157,10 @@ class ServiceGenerator {
         // 生成枚举翻译
         const enums = (0, lodash_1.filter)(interfaceTPConfigs, (item) => item.isEnum);
         if (!isGenJavaScript && !isOnlyGenTypeScriptType && !(0, lodash_1.isEmpty)(enums)) {
-            this.genFileFromTemplate(`${config_1.displayEnumLabelFileName}.ts`, config_1.TypescriptFileType.displayEnumLabel, {
+            this.genFileFromTemplate(`${config_2.displayEnumLabelFileName}.ts`, config_2.TypescriptFileType.displayEnumLabel, {
                 list: enums,
                 namespace: this.config.namespace,
-                interfaceFileName: config_1.interfaceFileName,
+                interfaceFileName: config_2.interfaceFileName,
             });
         }
         const displayTypeLabels = (0, lodash_1.filter)(interfaceTPConfigs, (item) => !item.isEnum);
@@ -167,10 +169,10 @@ class ServiceGenerator {
             !isOnlyGenTypeScriptType &&
             this.config.isDisplayTypeLabel &&
             !(0, lodash_1.isEmpty)(displayTypeLabels)) {
-            this.genFileFromTemplate(`${config_1.displayTypeLabelFileName}.ts`, config_1.TypescriptFileType.displayTypeLabel, {
+            this.genFileFromTemplate(`${config_2.displayTypeLabelFileName}.ts`, config_2.TypescriptFileType.displayTypeLabel, {
                 list: displayTypeLabels,
                 namespace: this.config.namespace,
-                interfaceFileName: config_1.interfaceFileName,
+                interfaceFileName: config_2.interfaceFileName,
             });
         }
         if (!isOnlyGenTypeScriptType) {
@@ -179,12 +181,12 @@ class ServiceGenerator {
             this.getServiceTPConfigs().forEach((tp) => {
                 const hasError = this.genFileFromTemplate(isGenJavaScript
                     ? (0, util_1.getFinalFileName)(`${tp.className}.js`)
-                    : (0, util_1.getFinalFileName)(`${tp.className}.ts`), config_1.TypescriptFileType.serviceController, Object.assign({ namespace: this.config.namespace, requestOptionsType: this.config.requestOptionsType, requestImportStatement: this.config.requestImportStatement, interfaceFileName: config_1.interfaceFileName }, tp));
+                    : (0, util_1.getFinalFileName)(`${tp.className}.ts`), config_2.TypescriptFileType.serviceController, Object.assign({ namespace: this.config.namespace, requestOptionsType: this.config.requestOptionsType, requestImportStatement: this.config.requestImportStatement, interfaceFileName: config_2.interfaceFileName }, tp));
                 prettierError.push(hasError);
                 if (this.config.isGenReactQuery) {
                     this.genFileFromTemplate(isGenJavaScript
-                        ? (0, util_1.getFinalFileName)(`${tp.className}.${config_1.reactQueryFileName}.js`)
-                        : (0, util_1.getFinalFileName)(`${tp.className}.${config_1.reactQueryFileName}.ts`), config_1.TypescriptFileType.reactQuery, Object.assign({ namespace: this.config.namespace, requestOptionsType: this.config.requestOptionsType, requestImportStatement: this.config.requestImportStatement, interfaceFileName: config_1.interfaceFileName }, tp));
+                        ? (0, util_1.getFinalFileName)(`${tp.className}.${reactQueryFileName}.js`)
+                        : (0, util_1.getFinalFileName)(`${tp.className}.${reactQueryFileName}.ts`), config_2.TypescriptFileType.reactQuery, Object.assign({ namespace: this.config.namespace, requestOptionsType: this.config.requestOptionsType, requestImportStatement: this.config.requestImportStatement, interfaceFileName: config_2.interfaceFileName, reactQueryModePackageName: (0, config_1.displayReactQueryMode)(reactQueryMode) }, tp));
                 }
             });
             if (prettierError.includes(true)) {
@@ -197,30 +199,30 @@ class ServiceGenerator {
             // 处理重复的 schemaName
             (0, util_1.handleDuplicateTypeNames)(this.schemaList);
             // 生成 schema 文件
-            this.genFileFromTemplate(isGenJavaScript ? `${config_1.schemaFileName}.js` : `${config_1.schemaFileName}.ts`, config_1.TypescriptFileType.schema, {
+            this.genFileFromTemplate(isGenJavaScript ? `${config_2.schemaFileName}.js` : `${config_2.schemaFileName}.ts`, config_2.TypescriptFileType.schema, {
                 list: this.schemaList,
             });
         }
         // 生成 service index 文件
         this.genFileFromTemplate(isGenJavaScript
-            ? `${config_1.serviceEntryFileName}.js`
-            : `${config_1.serviceEntryFileName}.ts`, config_1.TypescriptFileType.serviceIndex, {
+            ? `${config_2.serviceEntryFileName}.js`
+            : `${config_2.serviceEntryFileName}.ts`, config_2.TypescriptFileType.serviceIndex, {
             list: this.classNameList,
             namespace: this.config.namespace,
-            interfaceFileName: config_1.interfaceFileName,
-            genType: isGenJavaScript ? config_1.LangType.js : config_1.LangType.ts,
+            interfaceFileName: config_2.interfaceFileName,
+            genType: isGenJavaScript ? config_2.LangType.js : config_2.LangType.ts,
             isGenJsonSchemas: !isOnlyGenTypeScriptType &&
                 this.config.isGenJsonSchemas &&
                 !(0, lodash_1.isEmpty)(this.schemaList),
-            schemaFileName: config_1.schemaFileName,
+            schemaFileName: config_2.schemaFileName,
             isDisplayEnumLabel: !isOnlyGenTypeScriptType && !(0, lodash_1.isEmpty)(enums),
-            displayEnumLabelFileName: config_1.displayEnumLabelFileName,
+            displayEnumLabelFileName: config_2.displayEnumLabelFileName,
             isGenReactQuery: this.config.isGenReactQuery,
-            reactQueryFileName: config_1.reactQueryFileName,
+            reactQueryFileName,
             isDisplayTypeLabel: !isOnlyGenTypeScriptType &&
                 this.config.isDisplayTypeLabel &&
                 !(0, lodash_1.isEmpty)(displayTypeLabels),
-            displayTypeLabelFileName: config_1.displayTypeLabelFileName,
+            displayTypeLabelFileName: config_2.displayTypeLabelFileName,
         });
         // 打印日志
         (0, log_1.default)('✅ 成功生成 api 文件');
@@ -233,7 +235,7 @@ class ServiceGenerator {
         // 强行替换掉请求参数params的类型，生成方法对应的 xxxxParams 类型
         (0, lodash_1.keys)(this.openAPIData.paths).forEach((pathKey) => {
             const pathItem = this.openAPIData.paths[pathKey];
-            (0, lodash_1.forEach)(config_1.methods, (method) => {
+            (0, lodash_1.forEach)(config_2.methods, (method) => {
                 var _a, _b, _c, _d;
                 const operationObject = pathItem[method];
                 const hookCustomFileNames = ((_a = this.config.hook) === null || _a === void 0 ? void 0 : _a.customFileNames) || util_1.getDefaultFileTag;
@@ -250,13 +252,13 @@ class ServiceGenerator {
                 }
                 // 筛选出 pathItem 包含的 $ref 对应的schema
                 (0, util_1.markAllowedSchema)(JSON.stringify(pathItem), this.openAPIData);
-                operationObject.parameters = (_b = operationObject.parameters) === null || _b === void 0 ? void 0 : _b.filter((item) => (item === null || item === void 0 ? void 0 : item.in) !== `${config_1.parametersInsEnum.header}`);
+                operationObject.parameters = (_b = operationObject.parameters) === null || _b === void 0 ? void 0 : _b.filter((item) => (item === null || item === void 0 ? void 0 : item.in) !== `${config_2.parametersInsEnum.header}`);
                 const props = [];
                 (_c = operationObject.parameters) === null || _c === void 0 ? void 0 : _c.forEach((parameter) => {
                     var _a;
                     props.push({
                         name: parameter.name,
-                        desc: ((_a = parameter.description) !== null && _a !== void 0 ? _a : '').replace(config_1.lineBreakReg, ''),
+                        desc: ((_a = parameter.description) !== null && _a !== void 0 ? _a : '').replace(config_2.lineBreakReg, ''),
                         required: parameter.required || false,
                         type: this.getType(parameter.schema),
                     });
@@ -266,7 +268,7 @@ class ServiceGenerator {
                     var _a;
                     props.push({
                         name: parameter.name,
-                        desc: ((_a = parameter.description) !== null && _a !== void 0 ? _a : '').replace(config_1.lineBreakReg, ''),
+                        desc: ((_a = parameter.description) !== null && _a !== void 0 ? _a : '').replace(config_2.lineBreakReg, ''),
                         required: parameter.required,
                         type: this.getType(parameter.schema),
                     });
@@ -293,9 +295,9 @@ class ServiceGenerator {
             const getDefinesType = () => {
                 if (result === null || result === void 0 ? void 0 : result.type) {
                     return schema.type === 'object'
-                        ? type_1.SchemaObjectType.object
-                        : config_1.numberEnum.includes(result.type)
-                            ? type_1.SchemaObjectType.number
+                        ? config_1.SchemaObjectType.object
+                        : config_2.numberEnum.includes(result.type)
+                            ? config_1.SchemaObjectType.number
                             : result.type;
                 }
                 return 'Record<string, unknown>';
@@ -418,7 +420,7 @@ class ServiceGenerator {
                             : functionName, typeName: this.getFunctionParamsTypeName(newApi), path: getPrefixPath(), pathInComment: formattedPath.replace(/\*/g, '&#42;'), 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_1.lineBreakReg, '')
+                            ? (newApi.description || '').replace(config_2.lineBreakReg, '')
                             : [
                                 newApi.summary,
                                 newApi.description,
@@ -428,7 +430,7 @@ class ServiceGenerator {
                             ]
                                 .filter((s) => s)
                                 .join(' ')
-                                .replace(config_1.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: ((_f = (_e = this.config.hook) === null || _e === void 0 ? void 0 : _e.customOptionsDefaultValue) === null || _f === void 0 ? void 0 : _f.call(_e, newApi)) || {}, body,
+                                .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: ((_f = (_e = this.config.hook) === null || _e === void 0 ? void 0 : _e.customOptionsDefaultValue) === null || _f === void 0 ? void 0 : _f.call(_e, newApi)) || {}, body,
                         file, hasFormData: formData, response });
                 }
                 catch (error) {
@@ -450,7 +452,7 @@ class ServiceGenerator {
                 });
             }
             return {
-                genType: this.config.isGenJavaScript ? config_1.LangType.js : config_1.LangType.ts,
+                genType: this.config.isGenJavaScript ? config_2.LangType.js : config_2.LangType.ts,
                 className,
                 instanceName: `${(_b = fileName[0]) === null || _b === void 0 ? void 0 : _b.toLowerCase()}${fileName.slice(1)}`,
                 list: genParams,
@@ -519,7 +521,7 @@ class ServiceGenerator {
             return null;
         }
         let mediaType = (0, lodash_1.keys)(reqContent)[0];
-        const schema = ((_a = reqContent[mediaType]) === null || _a === void 0 ? void 0 : _a.schema) || config_1.DEFAULT_SCHEMA;
+        const schema = ((_a = reqContent[mediaType]) === null || _a === void 0 ? void 0 : _a.schema) || config_2.DEFAULT_SCHEMA;
         if (mediaType === '*/*') {
             mediaType = '';
         }
@@ -531,7 +533,7 @@ class ServiceGenerator {
                 var _a, _b;
                 const propertyObj = schema.properties[propertyKey];
                 if (propertyObj &&
-                    ![type_1.SchemaObjectFormat.binary, type_1.SchemaObjectFormat.base64].includes(propertyObj.format) &&
+                    ![config_1.SchemaObjectFormat.binary, config_1.SchemaObjectFormat.base64].includes(propertyObj.format) &&
                     !(0, util_1.isBinaryArraySchemaObject)(propertyObj)) {
                     // 测试了很多用例，很少有用例走到这里
                     return {
@@ -574,8 +576,8 @@ class ServiceGenerator {
                 // 这里 p.type 是自定义type, 注意别混淆
                 return {
                     title: p.name,
-                    multiple: p.type === `${type_1.SchemaObjectType.array}` ||
-                        p.type === `${type_1.SchemaObjectType.stringArray}`,
+                    multiple: p.type === `${config_1.SchemaObjectType.array}` ||
+                        p.type === `${config_1.SchemaObjectType.stringArray}`,
                 };
             });
         }
@@ -604,7 +606,7 @@ class ServiceGenerator {
             return defaultResponse;
         }
         let schema = (resContent[mediaType].schema ||
-            config_1.DEFAULT_SCHEMA);
+            config_2.DEFAULT_SCHEMA);
         if ((0, util_1.isReferenceObject)(schema)) {
             const refName = (0, util_1.getLastRefName)(schema.$ref);
             const childrenSchema = components.schemas[refName];
@@ -613,7 +615,7 @@ class ServiceGenerator {
                     .map((field) => childrenSchema.properties[field])
                     .filter(Boolean)) === null || _a === void 0 ? void 0 : _a[0]) ||
                     resContent[mediaType].schema ||
-                    config_1.DEFAULT_SCHEMA);
+                    config_2.DEFAULT_SCHEMA);
             }
         }
         if ((0, util_1.isSchemaObject)(schema)) {
@@ -631,7 +633,7 @@ class ServiceGenerator {
     getParamsTP(parameters = [], path = null) {
         const templateParams = {};
         if (parameters === null || parameters === void 0 ? void 0 : parameters.length) {
-            (0, lodash_1.forEach)(config_1.parametersIn, (source) => {
+            (0, lodash_1.forEach)(config_2.parametersIn, (source) => {
                 const params = parameters
                     .map((p) => this.resolveRefObject(p))
                     .filter((p) => p.in === source)
@@ -644,7 +646,7 @@ class ServiceGenerator {
                     const deRefObj = (0, lodash_1.entries)((_c = this.openAPIData.components) === null || _c === void 0 ? void 0 : _c.schemas).find(([k]) => k === refName) || [];
                     const isRefObject = ((_d = deRefObj[1]) === null || _d === void 0 ? void 0 : _d.type) === 'object' &&
                         !(0, lodash_1.isEmpty)((_e = deRefObj[1]) === null || _e === void 0 ? void 0 : _e.properties);
-                    return Object.assign(Object.assign({}, p), { isObject: isDirectObject || isRefObject, type: this.getType(p.schema || config_1.DEFAULT_SCHEMA, this.config.namespace) });
+                    return Object.assign(Object.assign({}, p), { isObject: isDirectObject || isRefObject, type: this.getType(p.schema || config_2.DEFAULT_SCHEMA, this.config.namespace) });
                 });
                 if (params.length) {
                     templateParams[source] = params;
@@ -657,7 +659,7 @@ class ServiceGenerator {
             let match = null;
             while ((match = regex.exec(path))) {
                 if (!templateParams.path.some((p) => p.name === match[1])) {
-                    templateParams.path.push(Object.assign(Object.assign({}, config_1.DEFAULT_PATH_PARAM), { name: match[1] }));
+                    templateParams.path.push(Object.assign(Object.assign({}, config_2.DEFAULT_PATH_PARAM), { name: match[1] }));
                 }
             }
             // 如果 path 没有内容，则将删除 path 参数，避免影响后续的 hasParams 判断
@@ -717,7 +719,7 @@ class ServiceGenerator {
         const enumArray = schemaObject.enum;
         let enumStr = '';
         let enumLabelTypeStr = '';
-        if (config_1.numberEnum.includes(schemaObject.type) || (0, util_1.isAllNumber)(enumArray)) {
+        if (config_2.numberEnum.includes(schemaObject.type) || (0, util_1.isAllNumber)(enumArray)) {
             enumStr = `{${(0, lodash_1.map)(enumArray, (value) => `"NUMBER_${value}"=${Number(value)}`).join(',')}}`;
         }
         else if ((0, util_1.isAllNumeric)(enumArray)) {
@@ -747,7 +749,7 @@ class ServiceGenerator {
             }).join(',')}}`;
         }
         else {
-            if (config_1.numberEnum.includes(schemaObject.type) || (0, util_1.isAllNumber)(enumArray)) {
+            if (config_2.numberEnum.includes(schemaObject.type) || (0, util_1.isAllNumber)(enumArray)) {
                 enumLabelTypeStr = `{${(0, lodash_1.map)(enumArray, (value) => `"NUMBER_${value}":${Number(value)}`).join(',')}}`;
             }
             else if ((0, util_1.isAllNumeric)(enumArray)) {
@@ -781,7 +783,7 @@ class ServiceGenerator {
         const requiredPropKeys = (_a = schemaObject === null || schemaObject === void 0 ? void 0 : schemaObject.required) !== null && _a !== void 0 ? _a : false;
         const properties = schemaObject.properties;
         return (0, lodash_1.keys)(properties).map((propKey) => {
-            const schema = ((properties === null || properties === void 0 ? void 0 : properties[propKey]) || config_1.DEFAULT_SCHEMA);
+            const schema = ((properties === null || properties === void 0 ? void 0 : properties[propKey]) || config_2.DEFAULT_SCHEMA);
             // 剔除属性键值中的特殊符号，因为函数入参变量存在特殊符号会导致解析文件失败
             // eslint-disable-next-line no-useless-escape
             propKey = propKey.replace(/[\[|\]]/g, '');
@@ -789,7 +791,7 @@ class ServiceGenerator {
             return Object.assign(Object.assign({}, schema), { name: propKey, type: this.getType(schema), desc: [schema.title, schema.description]
                     .filter((item) => item)
                     .join(' ')
-                    .replace(config_1.lineBreakReg, ''), 
+                    .replace(config_2.lineBreakReg, ''), 
                 // 如果没有 required 信息，默认全部是非必填
                 required: requiredPropKeys
                     ? requiredPropKeys.some((key) => key === propKey)

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { APIDataType } from './generator/type';
-import { ComponentsObject, OpenAPIObject, OperationObject, ReferenceObject, SchemaObject } from './type';
+import { ComponentsObject, IPriorityRule, IReactQueryMode, OpenAPIObject, OperationObject, ReferenceObject, SchemaObject } from './type';
 export * from './generator/patchSchema';
 export type GenerateServiceProps = {
     /**
@@ -25,7 +25,7 @@ export type GenerateServiceProps = {
     /**
      * 优先规则, include(只允许include列表) | exclude(只排除exclude列表) | both(允许include列表，排除exclude列表)
      */
-    priorityRule?: string;
+    priorityRule?: IPriorityRule;
     /**
      * 只解析归属于 tags 集合的 api 和 schema
      */
@@ -64,6 +64,10 @@ export type GenerateServiceProps = {
      * 是否生成 react-query 配置
      */
     isGenReactQuery?: boolean;
+    /**
+     * reactQuery 模式
+     */
+    reactQueryMode?: IReactQueryMode;
     /**
      * 是否生成 JavaScript, 不生成 TypeScript
      */
@@ -172,4 +176,4 @@ export type GenerateServiceProps = {
         customFileNames?: (operationObject: OperationObject, apiPath: string, apiMethod: string) => string[] | null;
     };
 };
-export declare function generateService({ requestLibPath, schemaPath, mockFolder, includeTags, excludeTags, authorization, isTranslateToEnglishTag, priorityRule, ...rest }: GenerateServiceProps): Promise<void>;
+export declare function generateService({ requestLibPath, schemaPath, mockFolder, includeTags, excludeTags, authorization, isTranslateToEnglishTag, priorityRule, reactQueryMode, ...rest }: GenerateServiceProps): Promise<void>;

package/dist/index.js

@@ -3,14 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateService = generateService;
 const tslib_1 = require("tslib");
 const lodash_1 = require("lodash");
+const config_1 = require("./config");
 const mockGenarator_1 = require("./generator/mockGenarator");
 const serviceGenarator_1 = tslib_1.__importDefault(require("./generator/serviceGenarator"));
-const type_1 = require("./type");
 const util_1 = require("./util");
 tslib_1.__exportStar(require("./generator/patchSchema"), exports);
 function generateService(_a) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
-        var { requestLibPath, schemaPath, mockFolder, includeTags, excludeTags, authorization, isTranslateToEnglishTag, priorityRule = type_1.PriorityRule.include } = _a, rest = tslib_1.__rest(_a, ["requestLibPath", "schemaPath", "mockFolder", "includeTags", "excludeTags", "authorization", "isTranslateToEnglishTag", "priorityRule"]);
+        var { requestLibPath, schemaPath, mockFolder, includeTags, excludeTags, authorization, isTranslateToEnglishTag, priorityRule = config_1.PriorityRule.include, reactQueryMode = config_1.ReactQueryMode.react } = _a, rest = tslib_1.__rest(_a, ["requestLibPath", "schemaPath", "mockFolder", "includeTags", "excludeTags", "authorization", "isTranslateToEnglishTag", "priorityRule", "reactQueryMode"]);
         if (!schemaPath) {
             return;
         }
@@ -24,11 +24,11 @@ function generateService(_a) {
         const requestImportStatement = (0, util_1.getImportStatement)(requestLibPath);
         const serviceGenerator = new serviceGenarator_1.default(Object.assign({ schemaPath, serversPath: './src/apis', requestImportStatement, enableLogging: false, priorityRule, includeTags: includeTags
                 ? (0, lodash_1.map)(includeTags, (item) => typeof item === 'string' ? item.toLowerCase() : item)
-                : priorityRule === type_1.PriorityRule.include
+                : priorityRule === config_1.PriorityRule.include
                     ? [/.*/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, 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 }, rest), openAPI);
         serviceGenerator.genFile();
         if (mockFolder) {
             (0, mockGenarator_1.mockGenerator)({

package/dist/type.d.ts

@@ -1,4 +1,5 @@
 import { OpenAPIV3 } from 'openapi-types';
+import { PriorityRule, ReactQueryMode, SchemaObjectFormat, SchemaObjectType } from './config';
 type Modify<T, R> = Omit<T, keyof R> & R;
 type ICustomBaseSchemaObject = {
     type: ISchemaObjectType;
@@ -52,37 +53,7 @@ export type RequestBodyObject = OpenAPIV3.RequestBodyObject;
 export type ContentObject = {
     [media: string]: OpenAPIV3.MediaTypeObject;
 };
-export declare enum SchemaObjectFormat {
-    int32 = "int32",
-    int64 = "int64",
-    float = "float",
-    double = "double",
-    byte = "byte",
-    binary = "binary",
-    date = "date",
-    dateTime = "date-time",
-    password = "password",
-    base64 = "base64"
-}
 export type ISchemaObjectFormat = keyof typeof SchemaObjectFormat;
-export declare enum SchemaObjectType {
-    array = "array",
-    stringArray = "string[]",
-    boolean = "boolean",
-    object = "object",
-    number = "number",
-    string = "string",
-    integer = "integer",
-    enum = "enum",
-    null = "null",
-    union = "union",
-    file = "file"
-}
-export declare enum PriorityRule {
-    include = "include",
-    exclude = "exclude",
-    both = "both"
-}
 export type GenerateRegExp = {
     includeTags: (string | RegExp)[];
     excludeTags: (string | RegExp)[];
@@ -90,4 +61,6 @@ export type GenerateRegExp = {
     excludePaths: (string | RegExp)[];
 };
 export type ISchemaObjectType = keyof typeof SchemaObjectType;
+export type IReactQueryMode = keyof typeof ReactQueryMode;
+export type IPriorityRule = keyof typeof PriorityRule;
 export {};

package/dist/type.js

@@ -1,36 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PriorityRule = exports.SchemaObjectType = exports.SchemaObjectFormat = void 0;
-var SchemaObjectFormat;
-(function (SchemaObjectFormat) {
-    SchemaObjectFormat["int32"] = "int32";
-    SchemaObjectFormat["int64"] = "int64";
-    SchemaObjectFormat["float"] = "float";
-    SchemaObjectFormat["double"] = "double";
-    SchemaObjectFormat["byte"] = "byte";
-    SchemaObjectFormat["binary"] = "binary";
-    SchemaObjectFormat["date"] = "date";
-    SchemaObjectFormat["dateTime"] = "date-time";
-    SchemaObjectFormat["password"] = "password";
-    SchemaObjectFormat["base64"] = "base64";
-})(SchemaObjectFormat || (exports.SchemaObjectFormat = SchemaObjectFormat = {}));
-var SchemaObjectType;
-(function (SchemaObjectType) {
-    SchemaObjectType["array"] = "array";
-    SchemaObjectType["stringArray"] = "string[]";
-    SchemaObjectType["boolean"] = "boolean";
-    SchemaObjectType["object"] = "object";
-    SchemaObjectType["number"] = "number";
-    SchemaObjectType["string"] = "string";
-    SchemaObjectType["integer"] = "integer";
-    SchemaObjectType["enum"] = "enum";
-    SchemaObjectType["null"] = "null";
-    SchemaObjectType["union"] = "union";
-    SchemaObjectType["file"] = "file";
-})(SchemaObjectType || (exports.SchemaObjectType = SchemaObjectType = {}));
-var PriorityRule;
-(function (PriorityRule) {
-    PriorityRule["include"] = "include";
-    PriorityRule["exclude"] = "exclude";
-    PriorityRule["both"] = "both";
-})(PriorityRule || (exports.PriorityRule = PriorityRule = {}));

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "openapi-ts-request",
-  "version": "1.0.1",
-  "description": "Swagger2/OpenAPI3/Apifox to TypeScript/JavaScript, request client(support any client), request mock service, enum and enum translation, react-query, type field label, JSON Schemas",
+  "version": "1.1.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",
     "pnpm": ">=9"
@@ -25,13 +25,13 @@
   ],
   "dependencies": {
     "@prettier/sync": "^0.5.2",
-    "@trivago/prettier-plugin-sort-imports": "^4.3.0",
+    "@trivago/prettier-plugin-sort-imports": "^5.2.1",
     "axios": "^1.7.2",
     "bing-translate-api": "^4.0.2",
     "chalk": "^4.1.2",
     "commander": "^12.1.0",
     "cosmiconfig": "^9.0.0",
-    "cosmiconfig-typescript-loader": "^5.0.0",
+    "cosmiconfig-typescript-loader": "^6.1.0",
     "glob": "^11.0.0",
     "js-yaml": "^4.1.0",
     "lodash": "^4.17.21",
@@ -52,6 +52,7 @@
     "@commitlint/cli": "^19.2.1",
     "@commitlint/config-conventional": "^19.2.2",
     "@tanstack/react-query": "^5.62.10",
+    "@tanstack/vue-query": "^5.62.16",
     "@types/js-yaml": "^4.0.9",
     "@types/lodash": "^4.17.5",
     "@types/memoizee": "^0.4.11",

package/templates/reactQuery.njk

@@ -2,9 +2,9 @@
   /* eslint-disable */
   // @ts-ignore
 {% endif -%}
-import { queryOptions, useMutation } from '@tanstack/react-query';
+import { queryOptions, useMutation } from '{{ reactQueryModePackageName }}';
 {%- if genType === "ts" %}
-  import type { DefaultError } from '@tanstack/react-query';
+  import type { DefaultError } from '{{ reactQueryModePackageName }}';
 {% endif %}
 
 import * as apis from './{{ className }}';