perf: perf customTemplates code and docs

Author: rookie-luochao

README-en_US.md

@@ -262,6 +262,7 @@ openapi -i ./spec.json -o ./apis
 | customClassName | (tagName: string) => string | custom tag name |
 | 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 | custom type <br> _returning a non-string will use the default method to get the type_ |
 | customFileNames | (<br>operationObject: OperationObject,<br>apiPath: string,<br>apiMethod: string,<br>) => string[] | custom generate request client controller file name, can return multiple: generate multiple files. <br> _if the return value is empty, the default getFileNames is used_ |
+| customTemplates | {<br>[TypescriptFileType.serviceController]?: <T, U>(item: T, context: U) => string;<br>} | custom template, details see source code |
 
 ## Apifox-Config
 

README.md

@@ -264,6 +264,7 @@ openapi --i ./spec.json --o ./apis
 | customClassName | (tagName: string) => string | 自定义标签名 |
 | 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>} | 自定义模板，详情请看源码 |
 
 ## Apifox-Config
 

src/generator/serviceGenarator.ts

@@ -70,6 +70,7 @@ import {
   ICustomSchemaObject,
   IPropObject,
   ISchemaItem,
+  IServiceControllerPayload,
   ITypeItem,
   ITypescriptFileType,
   type MergeOption,
@@ -330,27 +331,30 @@ export default class ServiceGenerator {
       // 生成 service controller 文件
       this.getServiceTPConfigs().forEach((tp) => {
         const { list, ...restTp } = tp;
-        const payload: Record<string, any> = {
+        const payload: Omit<typeof tp, 'list'> &
+          IServiceControllerPayload<typeof list> = {
           namespace: this.config.namespace,
           requestOptionsType: this.config.requestOptionsType,
           requestImportStatement: this.config.requestImportStatement,
           interfaceFileName: interfaceFileName,
+          list,
           ...restTp,
         };
-
         const hookCustomTemplateService =
           this.config.hook?.customTemplates?.[
             TypescriptFileType.serviceController
           ];
+
         if (hookCustomTemplateService) {
           payload.list = list.map((item) => {
             return {
               customTemplate: true,
-              data: hookCustomTemplateService(item, payload),
+              data: hookCustomTemplateService<typeof item, typeof payload>(
+                item,
+                payload
+              ),
             };
           });
-        } else {
-          payload.list = list;
         }
 
         const hasError = this.genFileFromTemplate(

src/generator/type.ts

@@ -69,3 +69,16 @@ type MergerOptionProps = {
 };
 
 export type MergerOptions = MergeOption & Partial<MergerOptionProps>;
+
+export type IServiceControllerPayload<T> = {
+  namespace: string;
+  requestOptionsType: string;
+  requestImportStatement: string;
+  interfaceFileName: string;
+  list:
+    | {
+        customTemplate: boolean;
+        data: string;
+      }[]
+    | T;
+};

src/index.ts

@@ -241,7 +241,10 @@ export type GenerateServiceProps = {
       /**
        * 自定义 serviceController 模板
        */
-      [TypescriptFileType.serviceController]?: (item: any, ctx: any) => string;
+      [TypescriptFileType.serviceController]?: <T, U>(
+        item: T,
+        context: U
+      ) => string;
     };
   };
 };