openapi-ts-request 1.8.4 → 1.9.0

package/README.md

@@ -267,6 +267,7 @@ openapi --i ./spec.json --o ./apis
 | customType | ({<br>schemaObject: SchemaObject \| ReferenceObject,<br>namespace: string,<br>originGetType:(schemaObject: SchemaObject \| ReferenceObject, namespace: string, schemas?: ComponentsObject['schemas']) => string,<br>schemas?: ComponentsObject['schemas'],<br>}) => string | 自定义类型 <br> _返回非字符串将使用默认方法获取type_ |
 | customFileNames | (<br>operationObject: OperationObject,<br>apiPath: string,<br>apiMethod: string,<br>) => string[] | 自定义生成的请求客户端文件名称，可以返回多个文件名称的数组(表示生成多个文件). <br> _返回为空，则使用默认的方法获取_ |
 | customTemplates | {<br>[TypescriptFileType.serviceController]?: <T, U>(item: T, context: U) => string;<br>} | 自定义模板，详情请看源码 |
+| customRenderTemplateData | {<br>[TypescriptFileType]?: (list: any[], context: {fileName: string, params: Record<string, unknown>}) => any[]<br>} | 自定义文件生成时的 list 参数处理，支持对不同文件类型进行精细化控制 |
 
 ## Apifox-Config
 

package/dist/generator/serviceGenarator.js

@@ -531,15 +531,75 @@ class ServiceGenerator {
             .filter((item) => { var _a; return !!((_a = item === null || item === void 0 ? void 0 : item.list) === null || _a === void 0 ? void 0 : _a.length); });
     }
     genFileFromTemplate(fileName, type, params) {
+        var _a;
         try {
             const template = this.getTemplate(type);
+            // 应用 customRenderTemplateData hook (如果存在)
+            let processedParams = Object.assign({}, params);
+            const customListHooks = (_a = this.config.hook) === null || _a === void 0 ? void 0 : _a.customRenderTemplateData;
+            if (customListHooks && params.list) {
+                try {
+                    const context = {
+                        fileName,
+                        params: processedParams,
+                    };
+                    let processedList = params.list;
+                    // 根据不同的文件类型调用相应的 hook 函数
+                    switch (type) {
+                        case config_2.TypescriptFileType.serviceController:
+                            if (customListHooks.serviceController) {
+                                processedList = customListHooks.serviceController(params.list, context);
+                            }
+                            break;
+                        case config_2.TypescriptFileType.reactQuery:
+                            if (customListHooks.reactQuery) {
+                                processedList = customListHooks.reactQuery(params.list, context);
+                            }
+                            break;
+                        case config_2.TypescriptFileType.interface:
+                            if (customListHooks.interface) {
+                                processedList = customListHooks.interface(params.list, context);
+                            }
+                            break;
+                        case config_2.TypescriptFileType.displayEnumLabel:
+                            if (customListHooks.displayEnumLabel) {
+                                processedList = customListHooks.displayEnumLabel(params.list, context);
+                            }
+                            break;
+                        case config_2.TypescriptFileType.displayTypeLabel:
+                            if (customListHooks.displayTypeLabel) {
+                                processedList = customListHooks.displayTypeLabel(params.list, context);
+                            }
+                            break;
+                        case config_2.TypescriptFileType.schema:
+                            if (customListHooks.schema) {
+                                processedList = customListHooks.schema(params.list, context);
+                            }
+                            break;
+                        case config_2.TypescriptFileType.serviceIndex:
+                            if (customListHooks.serviceIndex) {
+                                processedList = customListHooks.serviceIndex(params.list, context);
+                            }
+                            break;
+                    }
+                    if (processedList !== params.list) {
+                        processedParams = Object.assign(Object.assign({}, processedParams), { list: processedList });
+                        this.log(`customRenderTemplateData hook applied for ${type}: ${fileName}`);
+                    }
+                }
+                catch (error) {
+                    console.error(`[GenSDK] customRenderTemplateData hook error for ${type}:`, error);
+                    this.log(`customRenderTemplateData hook failed for ${type}, using original list`);
+                    // 发生错误时使用原始参数继续执行
+                }
+            }
             // 设置输出不转义
             const env = nunjucks_1.default.configure({
                 autoescape: false,
             });
             env.addFilter('capitalizeFirst', util_2.capitalizeFirstLetter);
             const destPath = (0, path_1.join)(this.config.serversPath, fileName);
-            const destCode = nunjucks_1.default.renderString(template, Object.assign({ disableTypeCheck: false }, params));
+            const destCode = nunjucks_1.default.renderString(template, Object.assign({ disableTypeCheck: false }, processedParams));
             let mergerProps = {};
             if ((0, fs_1.existsSync)(destPath)) {
                 mergerProps = {

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import type { TypescriptFileType } from './generator/config';
-import type { APIDataType, ITypeItem } from './generator/type';
+import type { APIDataType, ControllerType, ISchemaItem, ITypeItem } from './generator/type';
 import type { ComponentsObject, IPriorityRule, IReactQueryMode, OpenAPIObject, OperationObject, ReferenceObject, SchemaObject } from './type';
 import { type GetSchemaByApifoxProps } from './type';
 export * from './generator/patchSchema';
@@ -217,6 +217,61 @@ export type GenerateServiceProps = {
              */
             [TypescriptFileType.displayTypeLabel]?: <T, U>(types: T[], config: U) => ITypeItem[];
         };
+        /**
+         * 自定义 genFileFromTemplate 的 list 参数 hook
+         * 可以在模板渲染前对 list 参数进行自定义处理
+         */
+        customRenderTemplateData?: {
+            /**
+             * 自定义 serviceController 文件的 list 参数
+             */
+            [TypescriptFileType.serviceController]?: (list: APIDataType[], context: {
+                fileName: string;
+                params: Record<string, unknown>;
+            }) => APIDataType[];
+            /**
+             * 自定义 interface 文件的 list 参数
+             */
+            [TypescriptFileType.interface]?: (list: ITypeItem[], context: {
+                fileName: string;
+                params: Record<string, unknown>;
+            }) => ITypeItem[];
+            /**
+             * 自定义 displayEnumLabel 文件的 list 参数
+             */
+            [TypescriptFileType.displayEnumLabel]?: (list: ITypeItem[], context: {
+                fileName: string;
+                params: Record<string, unknown>;
+            }) => ITypeItem[];
+            /**
+             * 自定义 displayTypeLabel 文件的 list 参数
+             */
+            [TypescriptFileType.displayTypeLabel]?: (list: ITypeItem[], context: {
+                fileName: string;
+                params: Record<string, unknown>;
+            }) => ITypeItem[];
+            /**
+             * 自定义 schema 文件的 list 参数
+             */
+            [TypescriptFileType.schema]?: (list: ISchemaItem[], context: {
+                fileName: string;
+                params: Record<string, unknown>;
+            }) => ISchemaItem[];
+            /**
+             * 自定义 serviceIndex 文件的 list 参数
+             */
+            [TypescriptFileType.serviceIndex]?: (list: ControllerType[], context: {
+                fileName: string;
+                params: Record<string, unknown>;
+            }) => ControllerType[];
+            /**
+             * 自定义 reactQuery 文件的 list 参数
+             */
+            [TypescriptFileType.reactQuery]?: (list: APIDataType[], context: {
+                fileName: string;
+                params: Record<string, unknown>;
+            }) => APIDataType[];
+        };
     };
 };
 export declare function generateService({ requestLibPath, schemaPath, mockFolder, includeTags, excludeTags, includePaths, excludePaths, authorization, isTranslateToEnglishTag, priorityRule, timeout, reactQueryMode, apifoxConfig, ...rest }: GenerateServiceProps): Promise<void>;

package/package.json

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