@bitstack/ng-query-codegen-openapi 0.0.31-alpha.1 → 0.0.31-alpha.3

package/src/generators/tag-types-generator.ts

@@ -1,30 +1,46 @@
-/**
- * 生成 RTK Query 的 cache tag types 枚举文件
- * @param tags - 去重后的 tags 数组
- * @returns 生成的 TypeScript 枚举代码
- */
-export function generateTagTypesFile(tags: string[]): string {
-  // 如果没有 tags，生成一个空的枚举
-  if (tags.length === 0) {
-    return `/* eslint-disable */
-// [Warning] Generated automatically - do not edit manually
+import { toCamelCase } from './utils-generator';
 
-export enum ECacheTagTypes {
-}
-`;
-  }
+export function generateTagTypesFile(
+  allEndpointInfos: Array<{
+    operationName: string;
+    queryKeyName: string;
+    groupKey: string;
+  }>
+) {
+  // 按 group 分組
+  const groupedKeys = allEndpointInfos.reduce(
+    (acc, info) => {
+      if (!acc[info.groupKey]) {
+        acc[info.groupKey] = [];
+      }
+      acc[info.groupKey].push({
+        operationName: info.operationName,
+        queryKeyName: info.queryKeyName,
+      });
+      return acc;
+    },
+    {} as Record<string, Array<{ operationName: string; queryKeyName: string }>>
+  );
 
-  // 生成枚举项
-  const enumEntries = tags
-    .sort() // 按字母顺序排序
-    .map(tag => `    ${tag} = '${tag}',`)
-    .join('\n');
+  // 生成 enum 內容
+  const enumEntries = Object.entries(groupedKeys)
+    .map(([groupKey, keys]) => {
+      const groupComment = `  // ${groupKey.charAt(0).toUpperCase() + groupKey.slice(1)} related cache keys`;
+      const keyEntries = keys.map((key) => `  ${key.queryKeyName} = '${toCamelCase(key.queryKeyName)}',`).join('\n');
 
-  return `/* eslint-disable */
-// [Warning] Generated automatically - do not edit manually
+      return `${groupComment}\n${keyEntries}`;
+    })
+    .join('\n\n');
 
+  return `// [Warning] Generated automatically - do not edit manually 
+  
+/**
+ * Cache keys enum for all API queries
+ */
 export enum ECacheTagTypes {
 ${enumEntries}
 }
+
+export default ECacheTagTypes;
 `;
 }

package/src/services/api-code-generator.ts

@@ -56,6 +56,15 @@ export class ApiCodeGenerator {
     // 步驟 4: 生成 index 檔案
     const indexContent = this.generateIndex();
 
+    // 步驟 5: 收集端點快取鍵資訊（只收集 Query 類型的端點）
+    const allEndpointCacheKeys = endpointInfos
+      .filter((info) => info.isQuery) // 只收集查詢類型的端點
+      .map((info) => ({
+        operationName: info.operationName,
+        queryKeyName: info.queryKeyName,
+        groupKey: this.options.groupKey || '_common',
+      }));
+
     // 步驟 6: 收集操作名稱
     const operationNames = endpointInfos.map((info) => info.operationName);
 
@@ -75,6 +84,7 @@ export class ApiCodeGenerator {
         queryService: rtkQueryContent, // RTK Query 檔案
         index: indexContent,
         enhanceEndpoints: enhanceEndpointsContent, // 新增的 enhance endpoints 檔案
+        allEndpointCacheKeys: allEndpointCacheKeys,
       },
     };
   }

package/src/services/file-writer-service.ts

@@ -29,7 +29,7 @@ export class FileWriterService {
       if (fileName === 'enhanceEndpoints.ts' && fs.existsSync(resolvedPath)) {
         return {
           path: resolvedPath,
-          success: true
+          success: true,
         };
       }
 
@@ -39,13 +39,13 @@ export class FileWriterService {
 
       return {
         path: resolvedPath,
-        success: true
+        success: true,
       };
     } catch (error) {
       return {
         path: filePath,
         success: false,
-        error: error as Error
+        error: error as Error,
       };
     }
   }
@@ -65,7 +65,6 @@ export class FileWriterService {
     return results;
   }
 
-
   /**
    * 為群組寫入 RTK Query 檔案結構
    * @param groupOutputDir - 群組輸出目錄
@@ -110,6 +109,7 @@ export class FileWriterService {
     outputDir: string,
     sharedFiles: {
       commonTypes?: string;
+      tagTypes?: string;
       doNotModify?: string;
       utils?: string;
     }
@@ -119,7 +119,10 @@ export class FileWriterService {
     if (sharedFiles.commonTypes) {
       filesToWrite[path.join(outputDir, 'common-types.ts')] = sharedFiles.commonTypes;
     }
-    
+
+    if (sharedFiles.tagTypes) {
+      filesToWrite[path.join(outputDir, 'tagTypes.ts')] = sharedFiles.tagTypes;
+    }
 
     if (sharedFiles.doNotModify) {
       filesToWrite[path.join(outputDir, 'DO_NOT_MODIFY.md')] = sharedFiles.doNotModify;
@@ -137,16 +140,11 @@ export class FileWriterService {
    * @param outputDir - 輸出目錄
    * @param schema
    */
-  async writeSchemaFile(
-    outputDir: string,
-    schema: string
-  ): Promise<FileWriteResult[]> {
+  async writeSchemaFile(outputDir: string, schema: string): Promise<FileWriteResult[]> {
     const filesToWrite: Record<string, string> = {};
 
     filesToWrite[path.join(outputDir, 'schema.ts')] = schema;
 
     return this.writeFiles(filesToWrite);
   }
-
-
-}
+}

package/src/services/unified-code-generator.ts

@@ -13,6 +13,13 @@ import { ApiCodeGenerator } from './api-code-generator';
 import { generateUtilsFile } from '../generators/utils-generator';
 import { generateTagTypesFile } from '../generators/tag-types-generator';
 
+export interface EndpointCacheKey {
+  operationName: string;
+  queryKeyName: string;
+  groupKey: string;
+}
+
+
 /**
  * 統一代碼生成器選項
  */
@@ -51,13 +58,14 @@ export class UnifiedCodeGenerator {
   private openApiService = new OpenApiService();
   private groupService = new GroupService();
   private fileWriterService = new FileWriterService();
-  
+  private allEndpointCacheKeys: EndpointCacheKey[] = [];
+
   // 內部狀態存儲
   private openApiDoc: OpenAPIV3.Document | null = null;
   private parserService: OpenApiParserService | null = null;
   private schemaInterfaces: Record<string, ts.InterfaceDeclaration | ts.TypeAliasDeclaration> = {};
   private actualSchemaFile: string = '';
-  
+
   // 生成內容存儲
   private generatedContent: {
     groups: Array<{
@@ -76,19 +84,16 @@ export class UnifiedCodeGenerator {
     componentSchema: '',
     doNotModify: '',
     utils: '',
-    tagTypes: ''
+    tagTypes: '',
   };
 
   // 收集所有 tags
   private allTags: Set<string> = new Set();
 
-
   constructor(options: UnifiedGenerationOptions) {
     this._options = options;
   }
 
-
-
   /**
    * 一次性生成（整合所有階段）
    */
@@ -100,23 +105,21 @@ export class UnifiedCodeGenerator {
     // await this.generateQuery();
 
     // 生成共用
-    this.generateCommonTypesContent()
-    this.generateSchemaContent()
-    this.generateUtilsContent()
-    this.generateDoNotModifyContent()
-    this.generateTagTypesContent()
+    this.generateCommonTypesContent();
+    this.generateSchemaContent();
+    this.generateUtilsContent();
+    this.generateDoNotModifyContent();
+    this.generatECacheTagTypesContent();
 
     return await this.release();
   }
 
-
-
   /**
    * 準備階段：解析 schema 並初始化所有服務
    */
   async prepare(): Promise<void> {
     // console.log('UnifiedCodeGenerator: 準備階段開始...');
-    
+
     // 步驟 1: 解析實際的 schema 檔案路徑
     this.actualSchemaFile = this._options.schemaFile;
     if (this._options.remoteFile) {
@@ -127,10 +130,7 @@ export class UnifiedCodeGenerator {
     }
 
     // 步驟 2: 獲取 OpenAPI 文檔（只初始化一次）
-    this.openApiDoc = await this.openApiService.getDocument(
-      this.actualSchemaFile,
-      this._options.httpResolverOptions
-    );
+    this.openApiDoc = await this.openApiService.getDocument(this.actualSchemaFile, this._options.httpResolverOptions);
 
     // 步驟 3: 初始化解析器服務並處理 schema
     this.parserService = new OpenApiParserService(this.openApiDoc, this._options);
@@ -138,22 +138,23 @@ export class UnifiedCodeGenerator {
 
     // 步驟 4: 提取並儲存 schema interfaces
     const apiGen = this.parserService.getApiGenerator();
-    this.schemaInterfaces = apiGen.aliases.reduce<Record<string, ts.InterfaceDeclaration | ts.TypeAliasDeclaration>>((curr, alias) => {
-      if (ts.isInterfaceDeclaration(alias) || ts.isTypeAliasDeclaration(alias)) {
-        const name = alias.name.text;
-        return {
-          ...curr,
-          [name]: alias,
-        };
-      }
-      return curr;
-    }, {});
+    this.schemaInterfaces = apiGen.aliases.reduce<Record<string, ts.InterfaceDeclaration | ts.TypeAliasDeclaration>>(
+      (curr, alias) => {
+        if (ts.isInterfaceDeclaration(alias) || ts.isTypeAliasDeclaration(alias)) {
+          const name = alias.name.text;
+          return {
+            ...curr,
+            [name]: alias,
+          };
+        }
+        return curr;
+      },
+      {}
+    );
 
     // console.log('UnifiedCodeGenerator: 準備階段完成');
   }
 
-
-
   /**
    * 生成階段：產生所有內容但不寫檔
    */
@@ -171,17 +172,14 @@ export class UnifiedCodeGenerator {
     // 為每個群組生成內容
     for (const groupInfo of Object.values(groupInfos)) {
       try {
-        const groupContent = await this.generateApiGroupContent(
-          this._options,
-          groupInfo
-        );
+        const groupContent = await this.generateApiGroupContent(this._options, groupInfo);
 
         // 檢查群組是否有任何有效的 endpoint
         if (groupContent.operationNames.length > 0) {
           this.generatedContent.groups.push({
             groupKey: groupInfo.groupKey,
             outputPath: groupInfo.outputPath,
-            content: groupContent
+            content: groupContent,
           });
 
           // 收集此群組的所有 tags
@@ -198,7 +196,12 @@ export class UnifiedCodeGenerator {
     // console.log('UnifiedCodeGenerator: 內容生成階段完成');
   }
 
-
+  /**
+   * 生成 cache keys
+   */
+  private async generatECacheTagTypesContent(): Promise<void> {
+    this.generatedContent.tagTypes = generateTagTypesFile(this.allEndpointCacheKeys);
+  }
 
   /**
    * 生成 common types
@@ -221,7 +224,6 @@ export class UnifiedCodeGenerator {
     this.generatedContent.doNotModify = generateDoNotModifyFile();
   }
 
-
   /**
    * 生成 Utils Function
    */
@@ -232,13 +234,10 @@ export class UnifiedCodeGenerator {
   /**
    * 生成 Tag Types
    */
-  private async generateTagTypesContent(): Promise<void> {
-    const tagsArray = Array.from(this.allTags);
-    this.generatedContent.tagTypes = generateTagTypesFile(tagsArray);
-  }
-
-
-
+  // private async generateTagTypesContent(): Promise<void> {
+  //   const tagsArray = Array.from(this.allTags);
+  //   this.generatedContent.tagTypes = generateTagTypesFile(tagsArray);
+  // }
 
   /**
    * 發佈階段：統一寫入所有檔案
@@ -257,15 +256,12 @@ export class UnifiedCodeGenerator {
           if (group.content?.files) {
             const groupOutputDir = path.dirname(group.outputPath);
             // RTK Query 模式 (唯一支援模式)
-            const groupResults = await this.fileWriterService.writeGroupFiles(
-              groupOutputDir,
-              {
-                types: group.content.files.types,
-                queryService: group.content.files.queryService,
-                enhanceEndpoints: group.content.files.enhanceEndpoints,
-                index: group.content.files.index
-              }
-            );
+            const groupResults = await this.fileWriterService.writeGroupFiles(groupOutputDir, {
+              types: group.content.files.types,
+              queryService: group.content.files.queryService,
+              enhanceEndpoints: group.content.files.enhanceEndpoints,
+              index: group.content.files.index,
+            });
 
             results.push(...groupResults);
             generatedGroups.push(group.groupKey);
@@ -276,31 +272,26 @@ export class UnifiedCodeGenerator {
       }
 
       // 寫入共用檔案
-      const outputDir = this.generatedContent.groups[0] ? 
-        path.dirname(path.dirname(this.generatedContent.groups[0].outputPath)) : 
-        './generated';
+      const outputDir = this.generatedContent.groups[0]
+        ? path.dirname(path.dirname(this.generatedContent.groups[0].outputPath))
+        : './generated';
 
       // 寫入共用檔案 (包含 DO_NOT_MODIFY.md)
-      if (this.generatedContent.commonTypes || this.generatedContent.doNotModify || this.generatedContent.utils) {
-        const sharedResults = await this.fileWriterService.writeSharedFiles(
-          outputDir,
-          {
-            commonTypes: this.generatedContent.commonTypes || undefined,
-            doNotModify: this.generatedContent.doNotModify || undefined,
-            utils: this.generatedContent.utils || undefined
-          }
-        );
+      if (
+        this.generatedContent.tagTypes ||
+        this.generatedContent.commonTypes ||
+        this.generatedContent.doNotModify ||
+        this.generatedContent.utils
+      ) {
+        const sharedResults = await this.fileWriterService.writeSharedFiles(outputDir, {
+          tagTypes: this.generatedContent.tagTypes || undefined,
+          commonTypes: this.generatedContent.commonTypes || undefined,
+          doNotModify: this.generatedContent.doNotModify || undefined,
+          utils: this.generatedContent.utils || undefined,
+        });
         results.push(...sharedResults);
       }
 
-      // 寫入 tagTypes.ts
-      if (this.generatedContent.tagTypes) {
-        const tagTypesResult = await this.fileWriterService.writeFile(
-          path.join(outputDir, 'tagTypes.ts'),
-          this.generatedContent.tagTypes
-        );
-        results.push(tagTypesResult);
-      }
 
       // 寫入 component schema
       if (this.generatedContent.componentSchema) {
@@ -318,7 +309,6 @@ export class UnifiedCodeGenerator {
         mainIndexContent
       );
       results.push(mainIndexResult);
-
     } catch (error) {
       errors.push(error as Error);
     }
@@ -329,11 +319,10 @@ export class UnifiedCodeGenerator {
       success: errors.length === 0,
       writtenFiles: results,
       errors,
-      generatedGroups
+      generatedGroups,
     };
   }
 
-
   /**
    * 為單一群組生成內容
    */
@@ -358,10 +347,15 @@ export class UnifiedCodeGenerator {
     if (!this.openApiDoc || !this.parserService) {
       throw new Error('OpenAPI 文檔未初始化，請先調用 prepare()');
     }
-    
+
     const apiGenerator = new ApiCodeGenerator(this.parserService, groupOptions);
     const result = await apiGenerator.generate();
 
+    // 提取並儲存快取鍵
+    if (result.files && 'allEndpointCacheKeys' in result.files) {
+      const cacheKeys = result.files.allEndpointCacheKeys as EndpointCacheKey[];
+      this.allEndpointCacheKeys.push(...cacheKeys);
+    }
 
     return result;
   }
@@ -370,7 +364,7 @@ export class UnifiedCodeGenerator {
    * 生成主 index.ts 檔案
    */
   private generateMainIndex(generatedGroups: string[]): string {
-    const exports = generatedGroups.map(groupKey => `export * from "./${groupKey}";`).join('\n');
+    const exports = generatedGroups.map((groupKey) => `export * from "./${groupKey}";`).join('\n');
 
     return `/* eslint-disable */
 // [Warning] Generated automatically - do not edit manually
@@ -378,5 +372,4 @@ export class UnifiedCodeGenerator {
 ${exports}
 `;
   }
-
-}
+}

package/src/types.ts

@@ -204,6 +204,11 @@ export type GenerateApiResult = {
     enhanceEndpoints?: string; // RTK Query enhance endpoints file
     commonTypes?: string;
     componentSchema?: string;
+    allEndpointCacheKeys?: Array<{
+      operationName: string;
+      queryKeyName: string;
+      groupKey: string;
+    }>;
   };
 };