openapi-ts-request 1.4.0 → 1.5.1

package/dist/generator/serviceGenarator.d.ts

@@ -1,12 +1,13 @@
 import type { GenerateServiceProps } from '../index';
 import { OpenAPIObject } from '../type';
-import { ControllerType, ISchemaItem, TagAPIDataType } from './type';
+import { ControllerType, ISchemaItem, ITypeItem, TagAPIDataType } from './type';
 export default class ServiceGenerator {
     protected apiData: TagAPIDataType;
     protected classNameList: ControllerType[];
     protected config: GenerateServiceProps;
     protected openAPIData: OpenAPIObject;
     protected schemaList: ISchemaItem[];
+    protected interfaceTPConfigs: ITypeItem[];
     constructor(config: GenerateServiceProps, openAPIData: OpenAPIObject);
     genFile(): void;
     private getInterfaceTPConfigs;

package/dist/generator/serviceGenarator.js

@@ -22,6 +22,7 @@ class ServiceGenerator {
         this.apiData = {};
         this.classNameList = [];
         this.schemaList = [];
+        this.interfaceTPConfigs = [];
         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) || [];
@@ -148,37 +149,6 @@ class ServiceGenerator {
         const isGenJavaScript = this.config.isGenJavaScript;
         const reactQueryMode = this.config.reactQueryMode;
         const reactQueryFileName = (0, config_2.displayReactQueryFileName)(reactQueryMode);
-        // 处理重复的 typeName
-        const interfaceTPConfigs = this.getInterfaceTPConfigs();
-        (0, util_2.handleDuplicateTypeNames)(interfaceTPConfigs);
-        // 生成 ts 类型声明
-        if (!isGenJavaScript) {
-            this.genFileFromTemplate(`${config_2.interfaceFileName}.ts`, config_2.TypescriptFileType.interface, {
-                nullable: this.config.nullable,
-                list: interfaceTPConfigs,
-            });
-        }
-        // 生成枚举翻译
-        const enums = (0, lodash_1.filter)(interfaceTPConfigs, (item) => item.isEnum);
-        if (!isGenJavaScript && !isOnlyGenTypeScriptType && !(0, lodash_1.isEmpty)(enums)) {
-            this.genFileFromTemplate(`${config_2.displayEnumLabelFileName}.ts`, config_2.TypescriptFileType.displayEnumLabel, {
-                list: enums,
-                namespace: this.config.namespace,
-                interfaceFileName: config_2.interfaceFileName,
-            });
-        }
-        const displayTypeLabels = (0, lodash_1.filter)(interfaceTPConfigs, (item) => !item.isEnum);
-        // 生成 type 翻译
-        if (!isGenJavaScript &&
-            !isOnlyGenTypeScriptType &&
-            this.config.isDisplayTypeLabel &&
-            !(0, lodash_1.isEmpty)(displayTypeLabels)) {
-            this.genFileFromTemplate(`${config_2.displayTypeLabelFileName}.ts`, config_2.TypescriptFileType.displayTypeLabel, {
-                list: displayTypeLabels,
-                namespace: this.config.namespace,
-                interfaceFileName: config_2.interfaceFileName,
-            });
-        }
         if (!isOnlyGenTypeScriptType) {
             const prettierError = [];
             // 生成 service controller 文件
@@ -209,6 +179,37 @@ class ServiceGenerator {
                 (0, log_1.default)('🚥 格式化失败，请检查 service controller 文件内可能存在的语法错误');
             }
         }
+        // 处理重复的 typeName
+        this.interfaceTPConfigs = this.getInterfaceTPConfigs();
+        (0, util_2.handleDuplicateTypeNames)(this.interfaceTPConfigs);
+        // 生成 ts 类型声明
+        if (!isGenJavaScript) {
+            this.genFileFromTemplate(`${config_2.interfaceFileName}.ts`, config_2.TypescriptFileType.interface, {
+                nullable: this.config.nullable,
+                list: this.interfaceTPConfigs,
+            });
+        }
+        // 生成枚举翻译
+        const enums = (0, lodash_1.filter)(this.interfaceTPConfigs, (item) => item.isEnum);
+        if (!isGenJavaScript && !isOnlyGenTypeScriptType && !(0, lodash_1.isEmpty)(enums)) {
+            this.genFileFromTemplate(`${config_2.displayEnumLabelFileName}.ts`, config_2.TypescriptFileType.displayEnumLabel, {
+                list: enums,
+                namespace: this.config.namespace,
+                interfaceFileName: config_2.interfaceFileName,
+            });
+        }
+        const displayTypeLabels = (0, lodash_1.filter)(this.interfaceTPConfigs, (item) => !item.isEnum);
+        // 生成 type 翻译
+        if (!isGenJavaScript &&
+            !isOnlyGenTypeScriptType &&
+            this.config.isDisplayTypeLabel &&
+            !(0, lodash_1.isEmpty)(displayTypeLabels)) {
+            this.genFileFromTemplate(`${config_2.displayTypeLabelFileName}.ts`, config_2.TypescriptFileType.displayTypeLabel, {
+                list: displayTypeLabels,
+                namespace: this.config.namespace,
+                interfaceFileName: config_2.interfaceFileName,
+            });
+        }
         if (!isOnlyGenTypeScriptType &&
             this.config.isGenJsonSchemas &&
             !(0, lodash_1.isEmpty)(this.schemaList)) {
@@ -244,10 +245,11 @@ class ServiceGenerator {
         (0, log_1.default)('✅ 成功生成 api 文件目录-> ', this.config.serversPath);
     }
     getInterfaceTPConfigs() {
-        var _a, _b;
+        var _a, _b, _c;
         const schemas = (_a = this.openAPIData.components) === null || _a === void 0 ? void 0 : _a.schemas;
-        const lastTypes = [];
+        const lastTypes = this.interfaceTPConfigs;
         const includeTags = ((_b = this.config) === null || _b === void 0 ? void 0 : _b.includeTags) || [];
+        const includePaths = ((_c = this.config) === null || _c === void 0 ? void 0 : _c.includePaths) || [];
         // 强行替换掉请求参数params的类型，生成方法对应的 xxxxParams 类型
         (0, lodash_1.keys)(this.openAPIData.paths).forEach((pathKey) => {
             const pathItem = this.openAPIData.paths[pathKey];
@@ -259,11 +261,14 @@ class ServiceGenerator {
                     return;
                 }
                 const tags = hookCustomFileNames(operationObject, pathKey, method);
-                if ((0, lodash_1.isEmpty)(includeTags) || (!(0, lodash_1.isEmpty)(includeTags) && (0, lodash_1.isEmpty)(tags))) {
+                if ((0, lodash_1.isEmpty)(includeTags) ||
+                    (!(0, lodash_1.isEmpty)(includeTags) && (0, lodash_1.isEmpty)(tags)) ||
+                    (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);
-                if (!flag) {
+                const pathFlag = this.validateRegexp(pathKey, includePaths);
+                if (!flag || !pathFlag) {
                     return;
                 }
                 // 筛选出 pathItem 包含的 $ref 对应的schema
@@ -386,6 +391,26 @@ class ServiceGenerator {
                     else if (functionName) {
                         tmpFunctionRD[functionName] = 1;
                     }
+                    if (body === null || body === void 0 ? void 0 : body.isAnonymous) {
+                        const bodyName = (0, lodash_1.upperFirst)(`${functionName}Body`);
+                        this.interfaceTPConfigs.push({
+                            typeName: bodyName,
+                            type: body === null || body === void 0 ? void 0 : body.type,
+                            isEnum: false,
+                            props: [],
+                        });
+                        body.type = `${this.config.namespace}.${bodyName}`;
+                    }
+                    if (response === null || response === void 0 ? void 0 : response.isAnonymous) {
+                        const responseName = (0, lodash_1.upperFirst)(`${functionName}Response`);
+                        this.interfaceTPConfigs.push({
+                            typeName: responseName,
+                            type: response === null || response === void 0 ? void 0 : response.type,
+                            isEnum: false,
+                            props: [],
+                        });
+                        response.type = `${this.config.namespace}.${responseName}`;
+                    }
                     let formattedPath = newApi.path.replace(/:([^/]*)|{([^}]*)}/gi, (_, str, str2) => `$\{${str || str2}}`);
                     // 为 path 中的 params 添加 alias
                     const escapedPathParams = (0, lodash_1.map)(params.path, (item, index) => (Object.assign(Object.assign({}, item), { alias: `param${index}` })));
@@ -566,31 +591,20 @@ class ServiceGenerator {
         }
         // 如果 requestBody 有 required 属性，则正常展示；如果没有，默认非必填
         const required = typeof (requestBody === null || requestBody === void 0 ? void 0 : requestBody.required) === 'boolean' ? requestBody.required : false;
-        if (schema.type === 'object' && schema.properties) {
-            const propertiesList = (0, lodash_1.keys)(schema.properties)
-                .map((propertyKey) => {
-                var _a, _b;
-                const propertyObj = schema.properties[propertyKey];
-                if (propertyObj &&
-                    ![config_1.SchemaObjectFormat.binary, config_1.SchemaObjectFormat.base64].includes(propertyObj.format) &&
-                    !(0, util_2.isBinaryArraySchemaObject)(propertyObj)) {
-                    // 测试了很多用例，很少有用例走到这里
-                    return {
-                        key: propertyKey,
-                        schema: Object.assign(Object.assign({}, propertyObj), { type: this.getType(propertyObj, this.config.namespace), required: (_b = (_a = schema.required) === null || _a === void 0 ? void 0 : _a.includes(propertyKey)) !== null && _b !== void 0 ? _b : false }),
-                    };
-                }
-                return null;
-            })
-                .filter((p) => p);
-            return Object.assign(Object.assign({ mediaType }, schema), { required,
-                propertiesList });
-        }
-        return {
+        const bodySchema = {
             mediaType,
             required,
             type: this.getType(schema, this.config.namespace),
+            isAnonymous: false,
         };
+        // 具名 body 场景
+        if ((0, util_2.isReferenceObject)(schema)) {
+            bodySchema.type = `${this.config.namespace}.${bodySchema.type}`;
+        }
+        else {
+            bodySchema.isAnonymous = true;
+        }
+        return bodySchema;
     }
     getFileTP(requestBody) {
         var _a;
@@ -633,6 +647,7 @@ class ServiceGenerator {
         const defaultResponse = {
             mediaType: '*/*',
             type: 'unknown',
+            isAnonymous: false,
         };
         if (!response) {
             return defaultResponse;
@@ -647,6 +662,11 @@ class ServiceGenerator {
         }
         let schema = (resContent[mediaType].schema ||
             config_2.DEFAULT_SCHEMA);
+        const responseSchema = {
+            mediaType,
+            type: 'unknown',
+            isAnonymous: false,
+        };
         if ((0, util_2.isReferenceObject)(schema)) {
             const refName = (0, util_2.getLastRefName)(schema.$ref);
             const childrenSchema = components.schemas[refName];
@@ -657,6 +677,8 @@ class ServiceGenerator {
                     resContent[mediaType].schema ||
                     config_2.DEFAULT_SCHEMA);
             }
+            responseSchema.type = `${this.config.namespace}.${this.getType(schema, this.config.namespace)}`;
+            return responseSchema;
         }
         if ((0, util_2.isSchemaObject)(schema)) {
             (0, lodash_1.keys)(schema.properties).map((fieldName) => {
@@ -664,11 +686,10 @@ class ServiceGenerator {
                 schema.properties[fieldName]['required'] =
                     (_b = (_a = schema.required) === null || _a === void 0 ? void 0 : _a.includes(fieldName)) !== null && _b !== void 0 ? _b : false;
             });
+            responseSchema.isAnonymous = true;
         }
-        return {
-            mediaType,
-            type: this.getType(schema, this.config.namespace),
-        };
+        responseSchema.type = this.getType(schema, this.config.namespace);
+        return responseSchema;
     }
     getParamsTP(parameters = [], path = null) {
         const templateParams = {};

package/dist/generator/util.js

@@ -98,7 +98,8 @@ function getDefaultType(schemaObject, namespace = '', schemas) {
         return schemaObject;
     }
     if (isReferenceObject(schemaObject)) {
-        return [namespace, getRefName(schemaObject)].filter((s) => s).join('.');
+        return getRefName(schemaObject);
+        // return [namespace, getRefName(schemaObject)].filter((s) => s).join('.');
     }
     let type = schemaObject === null || schemaObject === void 0 ? void 0 : schemaObject.type;
     const dateEnum = ['Date', 'date', 'dateTime', 'date-time', 'datetime'];
@@ -200,8 +201,7 @@ function getDefaultType(schemaObject, namespace = '', schemas) {
              * 错误的继续保留字符串。
              * */
             return `
-        ${property.description ? `/** ${property.description} */` : ''}
-        '${key}'${required ? '' : '?'}: ${getDefaultType(property, namespace)}; `;
+        ${property.description ? `/** ${property.description} */\n` : ''}'${key}'${required ? '' : '?'}: ${getDefaultType(property, namespace)}; `;
         })
             .join('')}}`;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-ts-request",
-  "version": "1.4.0",
+  "version": "1.5.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",
@@ -24,7 +24,7 @@
     "prettier.config.cjs"
   ],
   "dependencies": {
-    "@prettier/sync": "^0.5.2",
+    "@prettier/sync": "^0.6.1",
     "@trivago/prettier-plugin-sort-imports": "^5.2.1",
     "axios": "^1.7.2",
     "bing-translate-api": "^4.0.2",
@@ -58,7 +58,7 @@
     "@types/lodash": "^4.17.5",
     "@types/memoizee": "^0.4.11",
     "@types/mockjs": "^1.0.10",
-    "@types/node": "^20.14.6",
+    "@types/node": "^22.15.17",
     "@types/nunjucks": "^3.2.6",
     "@types/reserved-words": "^0.1.4",
     "@types/swagger2openapi": "^7.0.4",
@@ -66,7 +66,7 @@
     "@typescript-eslint/parser": "^7.9.0",
     "eslint": "^8.57.1",
     "husky": "^9.0.11",
-    "lint-staged": "^15.3.0",
+    "lint-staged": "^16.0.0",
     "openapi-types": "^12.1.3",
     "ts-node": "^10.9.2",
     "typescript": "5.8.3"

package/templates/reactQuery.njk

@@ -42,18 +42,7 @@ import * as apis from './{{ className }}';
       {%- endif -%}
 
       {%- if api.body -%}
-        body: 
-        {% if api.body.propertiesList %}{
-          {%- for prop in api.body.propertiesList %}
-            {% if prop.schema.description -%}
-            /** {{ prop.schema.description }} */
-            {% endif -%}
-            '{{ prop.key }}'{{ "?" if not prop.schema.required }}: {{ prop.schema.type }},
-          {%- endfor %}
-        }
-        {%- else -%}
-          {{ api.body.type }}
-        {%- endif -%}
+        body: {{ api.body.type }}
         {{ ";" if api.file }}
       {%- endif %}
 

package/templates/serviceController.njk

@@ -56,19 +56,7 @@
         {%- endif -%}
 
         {%- if api.body -%}
-          body: 
-          {% if api.body.propertiesList %}
-            {
-            {%- for prop in api.body.propertiesList %}
-              {% if prop.schema.description -%}
-                /** {{ prop.schema.description }} */
-              {% endif -%}
-              '{{ prop.key }}'{{ "?" if not prop.schema.required }}: {{ prop.schema.type }},
-            {%- endfor %}
-            }
-          {%- else -%}
-            {{ api.body.type }}
-          {%- endif -%}
+          body: {{ api.body.type }}
           {{ ";" if api.file }}
         {%- endif %}