openapi-ts-request 1.7.3 → 1.8.1

package/README.md

@@ -194,6 +194,7 @@ $ openapi --help
     -f, --full <boolean>                full replacement (default: true)
     --enableLogging <boolean>           open the log (default: false)
     --priorityRule <string>             priority rule, include/exclude/both (default: "include")
+    --filterCaseInsensitive <boolean>   whether to perform a case-insensitive match with includeTags, includePaths, excludeTags, excludePaths filters
     --includeTags <(string|RegExp)[]>   generate code from include tags
     --includePaths <(string|RegExp)[]>  generate code from include paths
     --excludeTags <(string|RegExp)[]>   generate code from exclude tags
@@ -232,6 +233,7 @@ openapi --i ./spec.json --o ./apis
 | full | 否 | boolean | true | 是否全量替换 |
 | enableLogging | 否 | boolean | false | 是否开启日志 |
 | priorityRule | 否 | string | 'include' | 模式规则，可选include/exclude/both |
+| filterCaseInsensitive | 否 | boolean | false | 执行 includeTags、includePaths、excludeTags、excludePaths 过滤时是否忽略大小写 |
 | includeTags | 否 | (string\|RegExp)[] | - | 根据指定的 tags 生成代码, priorityRule=include则必填 |
 | includePaths | 否 | (string\|RegExp)[] | - | 根据指定的 paths 生成代码 |
 | excludeTags | 否 | (string\|RegExp)[] | - | 根据指定的 tags 不生成代码 |

package/dist/bin/openapi.js

@@ -21,7 +21,9 @@ const params = commander_1.program
     .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)
-    .option('--priorityRule <string>', 'priority rule, include/exclude/both (default: "include")')
+    .option('--filterCaseInsensitive <boolean>', 'whether to perform a case-insensitive match with includeTags, includePaths, excludeTags, excludePaths filters', false)
+    .option('--includeTags <(string|RegExp)[]>', 'generate code from include tags')
+    .option('--filterCaseInsensitive <boolean>', 'whether to perform a case-insensitive match with includeTags, includePaths, excludeTags, excludePaths filters', false)
     .option('--includeTags <(string|RegExp)[]>', 'generate code from include tags')
     .option('--includePaths <(string|RegExp)[]>', 'generate code from include paths')
     .option('--excludeTags <(string|RegExp)[]>', 'generate code from exclude tags')
@@ -60,6 +62,7 @@ const baseGenerate = (_params_) => {
         full: JSON.parse(_params_.full) === true,
         enableLogging: JSON.parse(_params_.enableLogging) === true,
         priorityRule: _params_.priorityRule,
+        filterCaseInsensitive: JSON.parse(_params_.filterCaseInsensitive) === true,
         includeTags: _params_.includeTags,
         includePaths: _params_.includePaths,
         excludeTags: _params_.excludeTags,

package/dist/generator/serviceGenarator.d.ts

@@ -55,6 +55,7 @@ export default class ServiceGenerator {
     private resolveEnumObject;
     private resolveAllOfObject;
     private getProps;
+    private resolveParameterRef;
     private resolveRefObject;
     log(message: string): void;
     private generateInfoLog;

package/dist/generator/serviceGenarator.js

@@ -91,19 +91,18 @@ class ServiceGenerator {
                     if (!tag) {
                         return;
                     }
-                    const tagLowerCase = tag.toLowerCase();
                     if (priorityRule === config_1.PriorityRule.include) {
                         // includeTags 为空，不会匹配任何path，故跳过
                         if ((0, lodash_1.isEmpty)(includeTags)) {
                             this.log('priorityRule include need includeTags or includePaths');
                             return;
                         }
-                        if (!this.validateRegexp(tagLowerCase, includeTags)) {
+                        if (!this.validateRegexp(tag, includeTags)) {
                             return;
                         }
                     }
                     if (priorityRule === config_1.PriorityRule.exclude) {
-                        if (this.validateRegexp(tagLowerCase, excludeTags)) {
+                        if (this.validateRegexp(tag, excludeTags)) {
                             return;
                         }
                     }
@@ -113,10 +112,8 @@ class ServiceGenerator {
                             this.log('priorityRule both need includeTags or includePaths');
                             return;
                         }
-                        const outIncludeTags = !(0, lodash_1.isEmpty)(includeTags) &&
-                            !this.validateRegexp(tagLowerCase, includeTags);
-                        const inExcludeTags = !(0, lodash_1.isEmpty)(excludeTags) &&
-                            this.validateRegexp(tagLowerCase, excludeTags);
+                        const outIncludeTags = !(0, lodash_1.isEmpty)(includeTags) && !this.validateRegexp(tag, includeTags);
+                        const inExcludeTags = !(0, lodash_1.isEmpty)(excludeTags) && this.validateRegexp(tag, excludeTags);
                         if (outIncludeTags || inExcludeTags) {
                             return;
                         }
@@ -276,33 +273,42 @@ class ServiceGenerator {
                     (0, lodash_1.isEmpty)(includePaths)) {
                     return;
                 }
-                const flag = this.validateRegexp((0, lodash_1.filter)((0, lodash_1.map)(tags, (tag) => (tag === null || tag === void 0 ? void 0 : tag.toLowerCase) ? tag.toLowerCase() : undefined), (tag) => !!tag), includeTags);
+                const flag = this.validateRegexp((0, lodash_1.filter)(tags, (tag) => !!tag), includeTags);
                 const pathFlag = this.validateRegexp(pathKey, includePaths);
                 if (!flag || !pathFlag) {
                     return;
                 }
                 // 筛选出 pathItem 包含的 $ref 对应的schema
                 (0, util_2.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_2.parametersInsEnum.header}`);
+                operationObject.parameters = (_b = operationObject.parameters) === null || _b === void 0 ? void 0 : _b.filter((item) => {
+                    const parameter = this.resolveParameterRef(item);
+                    return (parameter === null || parameter === void 0 ? void 0 : parameter.in) !== `${config_2.parametersInsEnum.header}`;
+                });
                 const props = [];
-                (_c = operationObject.parameters) === null || _c === void 0 ? void 0 : _c.forEach((parameter) => {
+                (_c = operationObject.parameters) === null || _c === void 0 ? void 0 : _c.forEach((param) => {
                     var _a;
-                    props.push({
-                        name: parameter.name,
-                        desc: ((_a = parameter.description) !== null && _a !== void 0 ? _a : '').replace(config_2.lineBreakReg, ''),
-                        required: parameter.required || false,
-                        type: this.getType(parameter.schema),
-                    });
+                    const parameter = this.resolveParameterRef(param);
+                    if (parameter) {
+                        props.push({
+                            name: parameter.name,
+                            desc: ((_a = parameter.description) !== null && _a !== void 0 ? _a : '').replace(config_2.lineBreakReg, ''),
+                            required: parameter.required || false,
+                            type: this.getType(parameter.schema),
+                        });
+                    }
                 });
                 // parameters may be in path
-                (_d = pathItem.parameters) === null || _d === void 0 ? void 0 : _d.forEach((parameter) => {
+                (_d = pathItem.parameters) === null || _d === void 0 ? void 0 : _d.forEach((param) => {
                     var _a;
-                    props.push({
-                        name: parameter.name,
-                        desc: ((_a = parameter.description) !== null && _a !== void 0 ? _a : '').replace(config_2.lineBreakReg, ''),
-                        required: parameter.required,
-                        type: this.getType(parameter.schema),
-                    });
+                    const parameter = this.resolveParameterRef(param);
+                    if (parameter) {
+                        props.push({
+                            name: parameter.name,
+                            desc: ((_a = parameter.description) !== null && _a !== void 0 ? _a : '').replace(config_2.lineBreakReg, ''),
+                            required: parameter.required,
+                            type: this.getType(parameter.schema),
+                        });
+                    }
                 });
                 const typeName = this.getFunctionParamsTypeName(Object.assign(Object.assign({}, operationObject), { method, path: pathKey }));
                 if (props.length > 0 && typeName) {
@@ -1000,6 +1006,16 @@ class ServiceGenerator {
                     : false });
         });
     }
+    resolveParameterRef(param) {
+        var _a, _b;
+        if (!(0, util_2.isReferenceObject)(param)) {
+            return param;
+        }
+        // 解析 $ref 引用，从 components.parameters 中获取实际定义
+        const refName = (0, util_2.getLastRefName)(param.$ref);
+        const parameter = (_b = (_a = this.openAPIData.components) === null || _a === void 0 ? void 0 : _a.parameters) === null || _b === void 0 ? void 0 : _b[refName];
+        return parameter || null;
+    }
     resolveRefObject(refObject) {
         if (!(0, util_2.isReferenceObject)(refObject)) {
             return refObject;
@@ -1061,7 +1077,9 @@ class ServiceGenerator {
     // 提取匹配逻辑到单独的函数
     matches(item, reg) {
         if (typeof reg === 'string') {
-            return (0, minimatch_1.minimatch)(item, reg);
+            return (0, minimatch_1.minimatch)(item, reg, {
+                nocase: this.config.filterCaseInsensitive,
+            });
         }
         else if (reg instanceof RegExp) {
             reg.lastIndex = 0; // 重置正则表达式的 lastIndex 属性

package/dist/index.d.ts

@@ -32,6 +32,10 @@ export type GenerateServiceProps = {
      * 优先规则, include(只允许include列表) | exclude(只排除exclude列表) | both(允许include列表，排除exclude列表)
      */
     priorityRule?: IPriorityRule;
+    /**
+     *  includeTags、includePaths、excludeTags、excludePaths 过滤器执行时是否忽略大小写
+     */
+    filterCaseInsensitive?: boolean;
     /**
      * 只解析归属于 tags 集合的 api 和 schema
      */

package/dist/index.js

@@ -34,7 +34,7 @@ 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) => (0, lodash_1.isString)(item) ? item.toLowerCase() : item)
+                ? includeTags
                 : priorityRule === config_1.PriorityRule.include ||
                     priorityRule === config_1.PriorityRule.both
                     ? [/.*/g]
@@ -43,9 +43,7 @@ function generateService(_a) {
                 : priorityRule === config_1.PriorityRule.include ||
                     priorityRule === config_1.PriorityRule.both
                     ? [/.*/g]
-                    : null, excludeTags: excludeTags
-                ? (0, lodash_1.map)(excludeTags, (item) => (0, lodash_1.isString)(item) ? item.toLowerCase() : item)
-                : null, excludePaths: excludePaths ? excludePaths : null, requestOptionsType: '{[key: string]: unknown}', namespace: 'API', isGenReactQuery: false, reactQueryMode, isGenJavaScript: false, isDisplayTypeLabel: false, isGenJsonSchemas: false, nullable: false, isOnlyGenTypeScriptType: false, isCamelCase: true, isSupportParseEnumDesc: false, full: true }, rest), openAPI);
+                    : null, excludeTags: excludeTags ? excludeTags : null, excludePaths: excludePaths ? excludePaths : null, requestOptionsType: '{[key: string]: unknown}', namespace: 'API', isGenReactQuery: false, reactQueryMode, isGenJavaScript: false, isDisplayTypeLabel: false, isGenJsonSchemas: false, nullable: false, isOnlyGenTypeScriptType: false, isCamelCase: true, isSupportParseEnumDesc: false, full: true }, rest), openAPI);
         serviceGenerator.genFile();
         if (mockFolder) {
             (0, mockGenarator_1.mockGenerator)({

package/package.json

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

package/templates/reactQuery.njk

@@ -60,7 +60,7 @@ import * as apis from './{{ className }}';
     {%- endif -%}
     ) {
       return queryOptions({
-        queryFn: async ({ queryKey }) => {
+        queryFn: ({ queryKey }) => {
           return apis.{{ api.functionName }}(queryKey[1]{{ " as typeof options" if genType === "ts" }});
         },
         queryKey: ['{{ api.functionName }}', options],

package/templates/serviceController.njk

@@ -12,7 +12,7 @@
     {{ api.data }}
   {% else %}
     /** {{ api.desc if api.desc else '此处后端没有提供注释' }} {{ api.method | upper }} {{ api.pathInComment | safe }}{{ ' ' if api.apifoxRunLink else '' }}{{ api.apifoxRunLink }} */
-    export async function {{ api.functionName }}({
+    export function {{ api.functionName }}({
       {%- if api.params and api.hasParams %}
         params
         {%- if api.hasParams -%}