@acrool/rtk-query-codegen-openapi 1.1.1 → 1.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@acrool/rtk-query-codegen-openapi",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "module": "lib/index.mjs",

package/src/generators/rtk-enhance-endpoints-generator.ts

@@ -14,7 +14,7 @@ export function generateRtkEnhanceEndpointsFile(endpointInfos: Array<{
   summary: string;
 }>, options: GenerationOptions) {
 
-  const { groupKey } = options;
+  const { groupKey, cacheTagTypes } = options;
 
   // 生成端點配置
   const endpointConfigs = endpointInfos.map(info => {
@@ -32,12 +32,20 @@ export function generateRtkEnhanceEndpointsFile(endpointInfos: Array<{
     }
   }).join('\n');
 
-  return `/* eslint-disable */
+  // 生成 import 語句
+  let importStatements = `/* eslint-disable */
 // [Warning] Generated automatically - do not edit manually
 
-import { ECacheTagTypes } from "@/store/tagTypes";
-import api from "./query.generated";
+`;
+
+  // 如果有 cacheTagTypes 配置，則添加導入
+  if (cacheTagTypes) {
+    importStatements += `import { ${cacheTagTypes.importReturnTypeName} } from "${cacheTagTypes.file}";\n`;
+  }
+
+  importStatements += `import api from "./query.generated";\n`;
 
+  return `${importStatements}
 const enhancedApi = api.enhanceEndpoints({
   endpoints: {
 ${endpointConfigs}
@@ -46,4 +54,4 @@ ${endpointConfigs}
 
 export default enhancedApi;
 `;
-}
+}

package/src/generators/rtk-query-generator.ts

@@ -86,7 +86,7 @@ ${paramsLines}
 `;
 
   const httpClientImport = options.httpClient
-    ? `import {${options.httpClient.importReturnTypeName || options.httpClient.importName}} from "${options.httpClient.file}";
+    ? `import {${options.httpClient.importReturnTypeName}} from "${options.httpClient.file}";
 `
     : `import {IRestFulEndpointsQueryReturn} from "@acrool/react-fetcher";
 `;
@@ -126,4 +126,4 @@ ${endpointInfos.map(info => {
 
 export default injectedRtkApi;
 `;
-}
+}

package/src/generators/types-generator.ts

@@ -56,30 +56,30 @@ export function generateTypesFile(
 // [Warning] Generated automatically - do not edit manually 
   
 `;
-  
+
   // 檢查是否需要引入 schema.ts
   const hasSchemaTypes = schemaInterfaces && Object.keys(schemaInterfaces).length > 0;
   if (hasSchemaTypes) {
     importStatement += `import * as Schema from "../schema";\n`;
   }
-  
+
   importStatement += '\n';
-  
+
   // 收集所有需要的類型定義
   const typeDefinitions: string[] = [];
-  
+
   // 注意：不再在 types.ts 中重複生成 schema 類型
   // schema 類型已經在 schema.ts 中生成，這裡直接使用 Schema.* 引用
-  
+
   // 無論是否有 schema，都要生成 endpoint 特定的 Req/Res 類型
   const endpointTypes: string[] = [];
-  
+
   // 為每個端點生成 Req/Res 類型
   endpointInfos.forEach(endpoint => {
     // 使用 endpoint 中提供的準確類型名稱
     const reqTypeName = endpoint.argTypeName;
     const resTypeName = endpoint.responseTypeName;
-    
+
     // 生成 Request 類型（總是生成）
     if (reqTypeName) {
       const requestTypeContent = generateRequestTypeContent(endpoint, operationDefinitions, schemaTypeMap);
@@ -99,7 +99,7 @@ export function generateTypesFile(
         );
       }
     }
-    
+
     // 生成 Response 類型（總是生成）
     if (resTypeName) {
       const responseTypeContent = generateResponseTypeContent(endpoint, operationDefinitions, schemaTypeMap);
@@ -120,11 +120,11 @@ export function generateTypesFile(
       }
     }
   });
-  
+
   if (endpointTypes.length > 0) {
     typeDefinitions.push(endpointTypes.join('\n'));
   }
-  
+
   // 如果沒有任何類型定義，至少添加一些基本說明
   if (typeDefinitions.length === 0) {
     typeDefinitions.push(
@@ -133,7 +133,7 @@ export function generateTypesFile(
       ``
     );
   }
-  
+
   return importStatement + typeDefinitions.join('\n\n');
 }
 
@@ -142,7 +142,7 @@ export function generateTypesFile(
  */
 function generateRequestTypeContent(endpoint: EndpointInfo, operationDefinitions?: any[], schemaTypeMap: Record<string, string> = {}): string {
   const properties: string[] = [];
-  
+
   // 如果有 query 參數
   if (endpoint.queryParams && endpoint.queryParams.length > 0) {
     endpoint.queryParams.forEach(param => {
@@ -151,7 +151,7 @@ function generateRequestTypeContent(endpoint: EndpointInfo, operationDefinitions
       properties.push(`  ${param.name}${optional}: ${paramType};`);
     });
   }
-  
+
   // 如果有 path 參數
   if (endpoint.pathParams && endpoint.pathParams.length > 0) {
     endpoint.pathParams.forEach(param => {
@@ -160,22 +160,22 @@ function generateRequestTypeContent(endpoint: EndpointInfo, operationDefinitions
       properties.push(`  ${param.name}${optional}: ${paramType};`);
     });
   }
-  
+
   // 如果有 request body（從 operationDefinitions 中獲取）
   const operationDef = operationDefinitions?.find(op => {
     // 嘗試多種匹配方式
     return op.operation?.operationId === endpoint.operationName ||
-           op.operation?.operationId === endpoint.operationName.toLowerCase() ||
-           // 也嘗試匹配 verb + path 組合
-           (op.verb === endpoint.verb.toLowerCase() && op.path === endpoint.path);
+      op.operation?.operationId === endpoint.operationName.toLowerCase() ||
+      // 也嘗試匹配 verb + path 組合
+      (op.verb === endpoint.verb.toLowerCase() && op.path === endpoint.path);
   });
-  
+
   if (operationDef?.operation?.requestBody) {
     const requestBody = operationDef.operation.requestBody;
     const content = requestBody.content;
 
-    // 處理不同的 content types
-    const jsonContent = content['application/json'];
+    // 處理不同的 content types，優先使用 application/json，其次嘗試其他類型
+    const jsonContent = content['application/json'] || content['*/*'];
     const formContent = content['multipart/form-data'] || content['application/x-www-form-urlencoded'];
 
     if (jsonContent?.schema) {
@@ -187,15 +187,22 @@ function generateRequestTypeContent(endpoint: EndpointInfo, operationDefinitions
       const bodyType = getTypeFromSchema(formContent.schema, schemaTypeMap, 1);
       properties.push(`  body: ${bodyType};`);
     } else {
-      properties.push(`  body?: any; // Request body from OpenAPI`);
+      // fallback 到第一個可用的 content-type
+      const firstContent = Object.values(content)[0] as any;
+      if (firstContent?.schema) {
+        const bodyType = getTypeFromSchema(firstContent.schema, schemaTypeMap, 1);
+        properties.push(`  body: ${bodyType};`);
+      } else {
+        properties.push(`  body?: any; // Request body from OpenAPI`);
+      }
     }
   }
-  
+
   // 如果沒有任何參數，返回空內容（將由調用方處理為 void）
   if (properties.length === 0) {
     return ''; // 返回空字串，讓調用方決定使用 void
   }
-  
+
   return properties.join('\n');
 }
 
@@ -204,23 +211,27 @@ function generateRequestTypeContent(endpoint: EndpointInfo, operationDefinitions
  */
 function generateResponseTypeContent(endpoint: EndpointInfo, operationDefinitions?: any[], schemaTypeMap: Record<string, string> = {}): string {
   const properties: string[] = [];
-  
+
   // 嘗試從 operationDefinitions 中獲取響應結構
   const operationDef = operationDefinitions?.find(op => {
     // 嘗試多種匹配方式
     return op.operation?.operationId === endpoint.operationName ||
-           op.operation?.operationId === endpoint.operationName.toLowerCase() ||
-           // 也嘗試匹配 verb + path 組合
-           (op.verb === endpoint.verb.toLowerCase() && op.path === endpoint.path);
+      op.operation?.operationId === endpoint.operationName.toLowerCase() ||
+      // 也嘗試匹配 verb + path 組合
+      (op.verb === endpoint.verb.toLowerCase() && op.path === endpoint.path);
   });
-  
+
   if (operationDef?.operation?.responses) {
     // 檢查 200 響應
-    const successResponse = operationDef.operation.responses['200'] || 
-                           operationDef.operation.responses['201'];
-    
+    const successResponse = operationDef.operation.responses['200'] ||
+      operationDef.operation.responses['201'];
+
     if (successResponse?.content) {
-      const jsonContent = successResponse.content['application/json'];
+      // 優先使用 application/json，其次嘗試其他 content-type（包括 */*）
+      const jsonContent = successResponse.content['application/json'] ||
+        successResponse.content['*/*'] ||
+        Object.values(successResponse.content)[0]; // fallback 到第一個可用的 content-type
+
       if (jsonContent?.schema) {
         const responseProps = parseSchemaProperties(jsonContent.schema, schemaTypeMap);
         properties.push(...responseProps);
@@ -230,12 +241,12 @@ function generateResponseTypeContent(endpoint: EndpointInfo, operationDefinition
       }
     }
   }
-  
+
   // 如果沒有響應定義，返回空內容（將由調用方處理為 void）
   if (properties.length === 0) {
     return ''; // 返回空字串，讓調用方決定使用 void
   }
-  
+
   return properties.join('\n');
 }
 
@@ -253,13 +264,16 @@ function parseSchemaProperties(schema: any, schemaTypeMap: Record<string, string
       const optional = isRequired ? '' : '?';
       // indentLevel=1 因為屬性已經在類型定義內（有 2 個空格縮排）
       const propType = getTypeFromSchema(propSchema, schemaTypeMap, 1);
-      const description = propSchema.description ? ` // ${propSchema.description}` : '';
 
       // 如果屬性名包含特殊字符（如 -），需要加上引號
       const needsQuotes = /[^a-zA-Z0-9_$]/.test(propName);
       const quotedPropName = needsQuotes ? `"${propName}"` : propName;
 
-      properties.push(`  ${quotedPropName}${optional}: ${propType};${description}`);
+      // 生成 JSDoc 註解
+      if (propSchema.description) {
+        properties.push(`  /** ${propSchema.description} */`);
+      }
+      properties.push(`  ${quotedPropName}${optional}: ${propType};`);
     });
   }
 
@@ -320,15 +334,23 @@ function getTypeFromSchema(schema: any, schemaTypeMap: Record<string, string> =
         // 如果有具體的屬性定義，生成內聯對象類型（多行格式）
         const entries = Object.entries(schema.properties);
 
-        // 如果沒有屬性，返回空物件
+        // 如果沒有屬性但有 additionalProperties，生成 Record 類型
         if (entries.length === 0) {
-          baseType = '{}';
+          if (schema.additionalProperties) {
+            const valueType = schema.additionalProperties === true
+              ? 'any'
+              : getTypeFromSchema(schema.additionalProperties, schemaTypeMap, indentLevel);
+            baseType = `Record<string, ${valueType}>`;
+          } else {
+            baseType = '{}';
+          }
         } else {
           // 計算下一層的縮排
           const nextIndent = '  '.repeat(indentLevel + 1);
           const currentIndent = '  '.repeat(indentLevel);
 
-          const props = entries.map(([key, propSchema]: [string, any]) => {
+          const props: string[] = [];
+          entries.forEach(([key, propSchema]: [string, any]) => {
             const required = schema.required || [];
             const optional = required.includes(key) ? '' : '?';
             const type = getTypeFromSchema(propSchema, schemaTypeMap, indentLevel + 1);
@@ -337,11 +359,21 @@ function getTypeFromSchema(schema: any, schemaTypeMap: Record<string, string> =
             const needsQuotes = /[^a-zA-Z0-9_$]/.test(key);
             const quotedKey = needsQuotes ? `"${key}"` : key;
 
-            return `${nextIndent}${quotedKey}${optional}: ${type};`;
-          }).join('\n');
+            // 生成 JSDoc 註解
+            if (propSchema.description) {
+              props.push(`${nextIndent}/** ${propSchema.description} */`);
+            }
+            props.push(`${nextIndent}${quotedKey}${optional}: ${type};`);
+          });
 
-          baseType = `{\n${props}\n${currentIndent}}`;
+          baseType = `{\n${props.join('\n')}\n${currentIndent}}`;
         }
+      } else if (schema.additionalProperties) {
+        // 如果沒有 properties 但有 additionalProperties
+        const valueType = schema.additionalProperties === true
+          ? 'any'
+          : getTypeFromSchema(schema.additionalProperties, schemaTypeMap, indentLevel);
+        baseType = `Record<string, ${valueType}>`;
       } else {
         baseType = 'any';
       }
@@ -361,4 +393,4 @@ function getTypeFromSchema(schema: any, schemaTypeMap: Record<string, string> =
 function getTypeFromParameter(param: any, schemaTypeMap: Record<string, string> = {}): string {
   if (!param.schema) return 'any';
   return getTypeFromSchema(param.schema, schemaTypeMap);
-}
+}

package/src/types.ts

@@ -3,13 +3,13 @@ import type { OpenAPIV3 } from 'openapi-types';
 import ts from 'typescript';
 
 // 重新匯出服務相關類型
-export type { 
+export type {
   GroupConfig,
-  GroupInfo 
+  GroupInfo
 } from './services/group-service';
 
-export type { 
-  FileWriteResult 
+export type {
+  FileWriteResult
 } from './services/file-writer-service';
 
 
@@ -38,14 +38,14 @@ export const operationKeys = ['get', 'put', 'post', 'delete', 'options', 'head',
 
 export type GenerationOptions = Id<
   CommonOptions &
-    Optional<OutputFileOptions, 'outputFile'> & {
-      isDataResponse?(
-        code: string,
-        includeDefault: boolean,
-        response: OpenAPIV3.ResponseObject,
-        allResponses: OpenAPIV3.ResponsesObject
-      ): boolean;
-    }
+  Optional<OutputFileOptions, 'outputFile'> & {
+  isDataResponse?(
+    code: string,
+    includeDefault: boolean,
+    response: OpenAPIV3.ResponseObject,
+    allResponses: OpenAPIV3.ResponsesObject
+  ): boolean;
+}
 >;
 
 export interface CommonOptions {
@@ -73,6 +73,15 @@ export interface CommonOptions {
     file: string;
     importReturnTypeName: string; // 用於指定別名導入，例如 IRestFulEndpointsQueryReturn
   };
+  /**
+   * Cache tag types configuration for RTK Query cache invalidation
+   * If provided, will import the specified type from the given file in enhanceEndpoints.ts
+   * Example: { file: "@/store/tagTypes", importName: "ECacheTagTypes" }
+   */
+  cacheTagTypes?: {
+    file: string;
+    importReturnTypeName: string;
+  };
   /**
    * defaults to "enhancedApi"
    */
@@ -189,11 +198,11 @@ export type OutputFilesConfig = {
 export type ConfigFile =
   | Id<Require<CommonOptions & OutputFileOptions, 'outputFile'>>
   | Id<
-      Omit<CommonOptions, 'outputFile'> & {
-        // outputFiles: { [outputFile: string]: Omit<OutputFileOptions, 'outputFile'> };
-        outputFiles: OutputFilesConfig
-      }
-    >;
+  Omit<CommonOptions, 'outputFile'> & {
+  // outputFiles: { [outputFile: string]: Omit<OutputFileOptions, 'outputFile'> };
+  outputFiles: OutputFilesConfig
+}
+>;
 
 export type GenerateApiResult = {
   operationNames: string[];
@@ -226,4 +235,4 @@ export type QueryArgDefinition = {
 }
   );
 
-export type QueryArgDefinitions = Record<string, QueryArgDefinition>;
+export type QueryArgDefinitions = Record<string, QueryArgDefinition>;