@acrool/rtk-query-codegen-openapi 0.0.2 → 0.0.6

package/src/index.ts

@@ -3,14 +3,177 @@ import { createRequire } from 'node:module';
 import path from 'node:path';
 import { generateApi } from './generate';
 import type { CommonOptions, ConfigFile, GenerationOptions, OutputFileOptions } from './types';
-import { isValidUrl, prettify } from './utils';
-export type { ConfigFile } from './types';
+import { isValidUrl, prettify, getV3Doc } from './utils';
+import camelCase from 'lodash.camelcase';
+export type { OutputFilesConfig, ConfigFile } from './types';
 
 const require = createRequire(__filename);
 
+
+
+// 確保目錄存在的函數
+async function ensureDirectoryExists(filePath: string) {
+  const dirname = path.dirname(filePath);
+  if (!fs.existsSync(dirname)) {
+    await fs.promises.mkdir(dirname, { recursive: true });
+  }
+}
+
+
+// 檢查檔案是否存在的函數
+function fileExists(filePath: string): boolean {
+  try {
+    return fs.statSync(filePath).isFile();
+  } catch {
+    return false;
+  }
+}
+
+// 獲取資料夾名稱並轉換為 API 名稱
+function getApiNameFromDir(dirPath: string): string {
+  const dirName = path.basename(dirPath);
+  return `${dirName}Api`;
+}
+
+// 確保基礎文件存在的函數
+async function ensureBaseFilesExist(outputDir: string) {
+  const enhanceEndpointsPath = path.join(outputDir, 'enhanceEndpoints.ts');
+  const indexPath = path.join(outputDir, 'index.ts');
+  const apiName = getApiNameFromDir(outputDir);
+
+  // 如果 enhanceEndpoints.ts 不存在，創建它
+  if (!fileExists(enhanceEndpointsPath)) {
+    const enhanceEndpointsContent = `import api from './query.generated';
+
+const enhancedApi = api.enhanceEndpoints({
+    endpoints: {
+    },
+});
+
+export default enhancedApi;
+`;
+    await fs.promises.writeFile(enhanceEndpointsPath, enhanceEndpointsContent, 'utf-8');
+  }
+
+  // 如果 index.ts 不存在，創建它
+  if (!fileExists(indexPath)) {
+    const indexContent = `export * from './query.generated';
+export {default as ${apiName}} from './enhanceEndpoints';
+`;
+    await fs.promises.writeFile(indexPath, indexContent, 'utf-8');
+  }
+}
+
+
+// 從路徑中提取分類名稱
+function getGroupNameFromPath(path: string, pattern: RegExp): string {
+  // console.log('pattern', pattern);
+
+  const match = path.match(pattern);
+  // console.log('match', path, match);
+
+  if (match && match[1]) {
+    return camelCase(match[1]);
+  }
+  return 'common';
+}
+
+
+
+
+
 export async function generateEndpoints(options: GenerationOptions): Promise<string | void> {
   const schemaLocation = options.schemaFile;
 
+  const schemaAbsPath = isValidUrl(options.schemaFile)
+    ? options.schemaFile
+    : path.resolve(process.cwd(), schemaLocation);
+
+  // 如果是 URL 且使用 outputFiles 配置，需要特殊處理
+  if (isValidUrl(options.schemaFile) && 'outputFiles' in options) {
+    const { outputFiles, ...commonConfig } = options as any;
+    
+    // 異步獲取 OpenAPI 文檔
+    const openApiDoc = await getV3Doc(options.schemaFile, options.httpResolverOptions);
+    const paths = Object.keys(openApiDoc.paths);
+
+    // 從配置中獲取分類規則
+    const outputFilesEntries = Object.entries(outputFiles);
+    const [outputPath, config] = outputFilesEntries[0];
+    const patterns = (config as any).groupMatch;
+    const filterEndpoint = (config as any).filterEndpoint;
+
+    const pattern = patterns;
+    // 根據路徑自動分類
+    const groupedPaths = paths.reduce((acc, path) => {
+      const groupName = getGroupNameFromPath(path, pattern);
+      if (!acc[groupName]) {
+        acc[groupName] = [];
+      }
+      acc[groupName].push(path);
+      return acc;
+    }, {} as Record<string, string[]>);
+
+    // 為每個分類生成配置並執行
+    for (const [groupName, paths] of Object.entries(groupedPaths)) {
+      const finalOutputPath = outputPath.replace('$1', groupName);
+
+      if (filterEndpoint) {
+        // 如果有 filterEndpoint，使用基於路徑的篩選函數
+        const pathBasedFilter = (operationName: string, operationDefinition: any) => {
+          const path = operationDefinition.path;
+          
+          // 檢查路徑是否匹配當前分組
+          const pathGroupName = getGroupNameFromPath(path, pattern);
+          if (pathGroupName !== groupName) {
+            return false;
+          }
+
+          // 使用 filterEndpoint 進行額外篩選
+          const endpointFilter = filterEndpoint(groupName);
+          if (endpointFilter instanceof RegExp) {
+            return endpointFilter.test(operationName);
+          }
+
+          return true;
+        };
+
+        const groupOptions = {
+          ...commonConfig,
+          outputFile: finalOutputPath,
+          filterEndpoints: pathBasedFilter,
+        };
+
+        await generateSingleEndpoint(groupOptions);
+      } else {
+        // 如果沒有 filterEndpoint，只使用路徑分組
+        const pathBasedFilter = (operationName: string, operationDefinition: any) => {
+          const path = operationDefinition.path;
+          
+          // 檢查路徑是否匹配當前分組
+          const pathGroupName = getGroupNameFromPath(path, pattern);
+          return pathGroupName === groupName;
+        };
+
+        const groupOptions = {
+          ...commonConfig,
+          outputFile: finalOutputPath,
+          filterEndpoints: pathBasedFilter,
+        };
+
+        await generateSingleEndpoint(groupOptions);
+      }
+    }
+    return;
+  }
+
+  // 原有的邏輯處理非 outputFiles 配置或本地文件
+  await generateSingleEndpoint(options);
+}
+
+async function generateSingleEndpoint(options: GenerationOptions): Promise<string | void> {
+  const schemaLocation = options.schemaFile;
+
   const schemaAbsPath = isValidUrl(options.schemaFile)
     ? options.schemaFile
     : path.resolve(process.cwd(), schemaLocation);
@@ -20,8 +183,15 @@ export async function generateEndpoints(options: GenerationOptions): Promise<str
   });
   const { outputFile, prettierConfigFile } = options;
   if (outputFile) {
+    const outputPath = path.resolve(process.cwd(), outputFile);
+    await ensureDirectoryExists(outputPath);
+
+    // 確保基礎文件存在
+    const outputDir = path.dirname(outputPath);
+    await ensureBaseFilesExist(outputDir);
+
     fs.writeFileSync(
-      path.resolve(process.cwd(), outputFile),
+      outputPath,
       await prettify(outputFile, sourceCode, prettierConfigFile)
     );
   } else {
@@ -34,13 +204,84 @@ export function parseConfig(fullConfig: ConfigFile) {
 
   if ('outputFiles' in fullConfig) {
     const { outputFiles, ...commonConfig } = fullConfig;
-    for (const [outputFile, specificConfig] of Object.entries(outputFiles)) {
-      outFiles.push({
-        ...commonConfig,
-        ...specificConfig,
-        outputFile,
-      });
+
+    // 讀取 OpenAPI 文檔 - 支援 URL 和本地文件
+    let openApiDoc: any;
+    if (isValidUrl(fullConfig.schemaFile)) {
+      // 如果是 URL，直接返回原始配置，讓 generateEndpoints 處理
+      outFiles.push(fullConfig as any);
+      return outFiles;
+    } else {
+      // 如果是本地文件，直接讀取
+      openApiDoc = JSON.parse(fs.readFileSync(fullConfig.schemaFile, 'utf-8'));
     }
+
+    const paths = Object.keys(openApiDoc.paths);
+
+    // 從配置中獲取分類規則
+    const outputFilesEntries = Object.entries(outputFiles);
+    const [outputPath, config] = outputFilesEntries[0];
+    const patterns = (config as any).groupMatch;
+    const filterEndpoint = (config as any).filterEndpoint;
+
+    const pattern = patterns;
+    // 根據路徑自動分類
+    const groupedPaths = paths.reduce((acc, path) => {
+      const groupName = getGroupNameFromPath(path, pattern);
+      if (!acc[groupName]) {
+        acc[groupName] = [];
+      }
+      acc[groupName].push(path);
+      return acc;
+    }, {} as Record<string, string[]>);
+
+    // 為每個分類生成配置
+    Object.entries(groupedPaths).forEach(([groupName, paths]) => {
+      const finalOutputPath = outputPath.replace('$1', groupName);
+
+      if (filterEndpoint) {
+        // 如果有 filterEndpoint，使用基於路徑的篩選函數
+        const pathBasedFilter = (operationName: string, operationDefinition: any) => {
+          const path = operationDefinition.path;
+          
+          // 檢查路徑是否匹配當前分組
+          const pathGroupName = getGroupNameFromPath(path, pattern);
+          if (pathGroupName !== groupName) {
+            return false;
+          }
+
+          // 使用 filterEndpoint 進行額外篩選
+          const endpointFilter = filterEndpoint(groupName);
+          if (endpointFilter instanceof RegExp) {
+            return endpointFilter.test(operationName);
+          }
+
+          return true;
+        };
+
+        outFiles.push({
+          ...commonConfig,
+          outputFile: finalOutputPath,
+          filterEndpoints: pathBasedFilter,
+        });
+      } else {
+        // 如果沒有 filterEndpoint，只使用路徑分組
+        const pathBasedFilter = (operationName: string, operationDefinition: any) => {
+          const path = operationDefinition.path;
+          
+          // 檢查路徑是否匹配當前分組
+          const pathGroupName = getGroupNameFromPath(path, pattern);
+          return pathGroupName === groupName;
+        };
+
+        outFiles.push({
+          ...commonConfig,
+          outputFile: finalOutputPath,
+          filterEndpoints: pathBasedFilter,
+        });
+      }
+    });
+
   } else {
     outFiles.push(fullConfig);
   }

package/src/types.ts

@@ -142,10 +142,18 @@ export type EndpointOverrides = {
   parameterFilter: ParameterMatcher;
 }>;
 
+export type OutputFilesConfig = {
+  [outputFile: string]: {
+      groupMatch: RegExp,
+      filterEndpoint?: (groupName: string) => RegExp
+    }
+};
+
 export type ConfigFile =
   | Id<Require<CommonOptions & OutputFileOptions, 'outputFile'>>
   | Id<
       Omit<CommonOptions, 'outputFile'> & {
-        outputFiles: { [outputFile: string]: Omit<OutputFileOptions, 'outputFile'> };
+        // outputFiles: { [outputFile: string]: Omit<OutputFileOptions, 'outputFile'> };
+        outputFiles: OutputFilesConfig
       }
     >;