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

package/src/index.ts

@@ -3,14 +3,12 @@ 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, getV3Doc } from './utils';
+import { prettify, getV3Doc, downloadSchemaFile } 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);
@@ -19,7 +17,6 @@ async function ensureDirectoryExists(filePath: string) {
   }
 }
 
-
 // 檢查檔案是否存在的函數
 function fileExists(filePath: string): boolean {
   try {
@@ -36,17 +33,23 @@ function getApiNameFromDir(dirPath: string): string {
 }
 
 // 確保基礎文件存在的函數
-async function ensureBaseFilesExist(outputDir: string) {
+async function ensureBaseFilesExist(outputDir: string, operationNames: 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 operationNamesString = operationNames
+      .map(name => `        ${name}: {},`)
+      .join('\n');
+
     const enhanceEndpointsContent = `import api from './query.generated';
 
 const enhancedApi = api.enhanceEndpoints({
     endpoints: {
+${operationNamesString}
     },
 });
 
@@ -54,6 +57,7 @@ export default enhancedApi;
 `;
     await fs.promises.writeFile(enhanceEndpointsPath, enhanceEndpointsContent, 'utf-8');
   }
+  // 如果文件已存在，不做任何修改
 
   // 如果 index.ts 不存在，創建它
   if (!fileExists(indexPath)) {
@@ -64,73 +68,63 @@ export {default as ${apiName}} from './enhanceEndpoints';
   }
 }
 
-
-// 從路徑中提取分類名稱
-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]);
+export async function generateEndpoints(options: GenerationOptions): Promise<string | void> {
+  // 如果有 remoteFile，先下載到 schemaFile 路徑
+  let actualSchemaFile = options.schemaFile;
+  
+  if (options.remoteFile) {
+    actualSchemaFile = await downloadSchemaFile(options.remoteFile, options.schemaFile);
   }
-  return 'common';
-}
-
+  
+  // 更新 options 中的 schemaFile 為實際的檔案路徑
+  const updatedOptions = {
+    ...options,
+    schemaFile: actualSchemaFile
+  };
 
+  const schemaLocation = updatedOptions.schemaFile;
 
+  const schemaAbsPath = path.resolve(process.cwd(), schemaLocation);
 
-
-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;
+  // 如果是使用 outputFiles 配置，需要特殊處理
+  if ('outputFiles' in options) {
+    const { outputFiles, ...commonConfig } = updatedOptions as any;
     
     // 異步獲取 OpenAPI 文檔
-    const openApiDoc = await getV3Doc(options.schemaFile, options.httpResolverOptions);
+    const openApiDoc = await getV3Doc(actualSchemaFile, updatedOptions.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 { groupKeyMatch, outputDir, filterEndpoint, queryMatch } = outputFiles;
 
-    const pattern = patterns;
     // 根據路徑自動分類
     const groupedPaths = paths.reduce((acc, path) => {
-      const groupName = getGroupNameFromPath(path, pattern);
-      if (!acc[groupName]) {
-        acc[groupName] = [];
+      // 使用 groupKeyMatch 方法獲取 groupKey，並轉換為小駝峰格式
+      const groupKey = camelCase(groupKeyMatch(path));
+      if (!acc[groupKey]) {
+        acc[groupKey] = [];
       }
-      acc[groupName].push(path);
+      acc[groupKey].push(path);
       return acc;
     }, {} as Record<string, string[]>);
 
     // 為每個分類生成配置並執行
-    for (const [groupName, paths] of Object.entries(groupedPaths)) {
-      const finalOutputPath = outputPath.replace('$1', groupName);
+    for (const [groupKey, paths] of Object.entries(groupedPaths)) {
+      const finalOutputPath = `${outputDir}/${groupKey}/query.generated.ts`;
 
       if (filterEndpoint) {
         // 如果有 filterEndpoint，使用基於路徑的篩選函數
         const pathBasedFilter = (operationName: string, operationDefinition: any) => {
           const path = operationDefinition.path;
-          
+
           // 檢查路徑是否匹配當前分組
-          const pathGroupName = getGroupNameFromPath(path, pattern);
-          if (pathGroupName !== groupName) {
+          const pathGroupKey = camelCase(groupKeyMatch(path));
+          if (pathGroupKey !== groupKey) {
             return false;
           }
 
           // 使用 filterEndpoint 進行額外篩選
-          const endpointFilter = filterEndpoint(groupName);
+          const endpointFilter = filterEndpoint(groupKey);
           if (endpointFilter instanceof RegExp) {
             return endpointFilter.test(operationName);
           }
@@ -141,7 +135,9 @@ export async function generateEndpoints(options: GenerationOptions): Promise<str
         const groupOptions = {
           ...commonConfig,
           outputFile: finalOutputPath,
+          sharedTypesFile: `${outputDir}/shared-types.ts`,
           filterEndpoints: pathBasedFilter,
+          queryMatch,
         };
 
         await generateSingleEndpoint(groupOptions);
@@ -149,16 +145,18 @@ export async function generateEndpoints(options: GenerationOptions): Promise<str
         // 如果沒有 filterEndpoint，只使用路徑分組
         const pathBasedFilter = (operationName: string, operationDefinition: any) => {
           const path = operationDefinition.path;
-          
+
           // 檢查路徑是否匹配當前分組
-          const pathGroupName = getGroupNameFromPath(path, pattern);
-          return pathGroupName === groupName;
+          const pathGroupKey = camelCase(groupKeyMatch(path));
+          return pathGroupKey === groupKey;
         };
 
         const groupOptions = {
           ...commonConfig,
           outputFile: finalOutputPath,
+          sharedTypesFile: `${outputDir}/shared-types.ts`,
           filterEndpoints: pathBasedFilter,
+          queryMatch,
         };
 
         await generateSingleEndpoint(groupOptions);
@@ -168,19 +166,18 @@ export async function generateEndpoints(options: GenerationOptions): Promise<str
   }
 
   // 原有的邏輯處理非 outputFiles 配置或本地文件
-  await generateSingleEndpoint(options);
+  await generateSingleEndpoint(updatedOptions);
 }
 
 async function generateSingleEndpoint(options: GenerationOptions): Promise<string | void> {
   const schemaLocation = options.schemaFile;
 
-  const schemaAbsPath = isValidUrl(options.schemaFile)
-    ? options.schemaFile
-    : path.resolve(process.cwd(), schemaLocation);
+  const schemaAbsPath = path.resolve(process.cwd(), schemaLocation);
 
-  const sourceCode = await enforceOazapftsTsVersion(async () => {
+  const result = await enforceOazapftsTsVersion(async () => {
     return generateApi(schemaAbsPath, options);
   });
+  
   const { outputFile, prettierConfigFile } = options;
   if (outputFile) {
     const outputPath = path.resolve(process.cwd(), outputFile);
@@ -188,14 +185,14 @@ async function generateSingleEndpoint(options: GenerationOptions): Promise<strin
 
     // 確保基礎文件存在
     const outputDir = path.dirname(outputPath);
-    await ensureBaseFilesExist(outputDir);
+    await ensureBaseFilesExist(outputDir, result.operationNames);
 
     fs.writeFileSync(
       outputPath,
-      await prettify(outputFile, sourceCode, prettierConfigFile)
+      await prettify(outputFile, result.sourceCode, prettierConfigFile)
     );
   } else {
-    return await prettify(null, sourceCode, prettierConfigFile);
+    return await prettify(null, result.sourceCode, prettierConfigFile);
   }
 }
 
@@ -205,10 +202,11 @@ export function parseConfig(fullConfig: ConfigFile) {
   if ('outputFiles' in fullConfig) {
     const { outputFiles, ...commonConfig } = fullConfig;
 
-    // 讀取 OpenAPI 文檔 - 支援 URL 和本地文件
+    // 讀取 OpenAPI 文檔 - 支援本地文件
     let openApiDoc: any;
-    if (isValidUrl(fullConfig.schemaFile)) {
-      // 如果是 URL，直接返回原始配置，讓 generateEndpoints 處理
+    
+    // 如果有 remoteFile，直接返回原始配置，讓 generateEndpoints 處理下載
+    if (fullConfig.remoteFile) {
       outFiles.push(fullConfig as any);
       return outFiles;
     } else {
@@ -219,39 +217,36 @@ export function parseConfig(fullConfig: ConfigFile) {
     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 { groupKeyMatch, outputDir, filterEndpoint, queryMatch } = outputFiles;
 
-    const pattern = patterns;
     // 根據路徑自動分類
     const groupedPaths = paths.reduce((acc, path) => {
-      const groupName = getGroupNameFromPath(path, pattern);
-      if (!acc[groupName]) {
-        acc[groupName] = [];
+      // 使用 groupKeyMatch 方法獲取 groupKey，並轉換為小駝峰格式
+      const groupKey = camelCase(groupKeyMatch(path));
+      if (!acc[groupKey]) {
+        acc[groupKey] = [];
       }
-      acc[groupName].push(path);
+      acc[groupKey].push(path);
       return acc;
     }, {} as Record<string, string[]>);
 
     // 為每個分類生成配置
-    Object.entries(groupedPaths).forEach(([groupName, paths]) => {
-      const finalOutputPath = outputPath.replace('$1', groupName);
+    Object.entries(groupedPaths).forEach(([groupKey, paths]) => {
+      const finalOutputPath = `${outputDir}/${groupKey}/query.generated.ts`;
 
       if (filterEndpoint) {
         // 如果有 filterEndpoint，使用基於路徑的篩選函數
         const pathBasedFilter = (operationName: string, operationDefinition: any) => {
           const path = operationDefinition.path;
-          
+
           // 檢查路徑是否匹配當前分組
-          const pathGroupName = getGroupNameFromPath(path, pattern);
-          if (pathGroupName !== groupName) {
+          const pathGroupKey = camelCase(groupKeyMatch(path));
+          if (pathGroupKey !== groupKey) {
             return false;
           }
 
           // 使用 filterEndpoint 進行額外篩選
-          const endpointFilter = filterEndpoint(groupName);
+          const endpointFilter = filterEndpoint(groupKey);
           if (endpointFilter instanceof RegExp) {
             return endpointFilter.test(operationName);
           }
@@ -262,22 +257,26 @@ export function parseConfig(fullConfig: ConfigFile) {
         outFiles.push({
           ...commonConfig,
           outputFile: finalOutputPath,
+          sharedTypesFile: `${outputDir}/shared-types.ts`,
           filterEndpoints: pathBasedFilter,
+          queryMatch,
         });
       } else {
         // 如果沒有 filterEndpoint，只使用路徑分組
         const pathBasedFilter = (operationName: string, operationDefinition: any) => {
           const path = operationDefinition.path;
-          
+
           // 檢查路徑是否匹配當前分組
-          const pathGroupName = getGroupNameFromPath(path, pattern);
-          return pathGroupName === groupName;
+          const pathGroupKey = camelCase(groupKeyMatch(path));
+          return pathGroupKey === groupKey;
         };
 
         outFiles.push({
           ...commonConfig,
           outputFile: finalOutputPath,
+          sharedTypesFile: `${outputDir}/shared-types.ts`,
           filterEndpoints: pathBasedFilter,
+          queryMatch,
         });
       }
     });

package/src/types.ts

@@ -34,9 +34,13 @@ export type GenerationOptions = Id<
 export interface CommonOptions {
   apiFile: string;
   /**
-   * filename or url
+   * local schema file path (only supports local files)
    */
   schemaFile: string;
+  /**
+   * remote schema file URL (when provided, will download to schemaFile path)
+   */
+  remoteFile?: string;
   /**
    * defaults to "api"
    */
@@ -111,6 +115,11 @@ export interface CommonOptions {
    * resolution mechanism will be used.
    */
   prettierConfigFile?: string;
+  /**
+   * defaults to "@acrool/react-fetcher"
+   * File path for importing IRestFulEndpointsQueryReturn type
+   */
+  endpointsQueryReturnTypeFile?: string;
 }
 
 export type TextMatcher = string | RegExp | (string | RegExp)[];
@@ -127,6 +136,7 @@ export interface OutputFileOptions extends Partial<CommonOptions> {
   outputFile: string;
   filterEndpoints?: EndpointMatcher;
   endpointOverrides?: EndpointOverrides[];
+  queryMatch?: (method: string, path: string) => boolean;
   /**
    * defaults to false
    * If passed as true it will generate TS enums instead of union of strings
@@ -143,10 +153,10 @@ export type EndpointOverrides = {
 }>;
 
 export type OutputFilesConfig = {
-  [outputFile: string]: {
-      groupMatch: RegExp,
-      filterEndpoint?: (groupName: string) => RegExp
-    }
+  groupKeyMatch: (path: string) => string;
+  outputDir: string;
+  queryMatch?: (method: string, path: string) => boolean;
+  filterEndpoint?: (groupName: string) => RegExp;
 };
 
 export type ConfigFile =
@@ -157,3 +167,8 @@ export type ConfigFile =
         outputFiles: OutputFilesConfig
       }
     >;
+
+export type GenerateApiResult = {
+  sourceCode: string;
+  operationNames: string[];
+};

package/src/utils/downloadSchema.ts

@@ -0,0 +1,33 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { isValidUrl } from './isValidUrl';
+
+export async function downloadSchemaFile(remoteFile: string, targetPath: string): Promise<string> {
+  // 如果不是網址，拋出錯誤
+  if (!isValidUrl(remoteFile)) {
+    throw new Error(`remoteFile must be a valid URL: ${remoteFile}`);
+  }
+
+  try {
+    // 確保目錄存在
+    const dir = path.dirname(targetPath);
+    if (!fs.existsSync(dir)) {
+      await fs.promises.mkdir(dir, { recursive: true });
+    }
+
+    // 下載檔案
+    const response = await fetch(remoteFile);
+    if (!response.ok) {
+      throw new Error(`Failed to download schema from ${remoteFile}: ${response.statusText}`);
+    }
+
+    const content = await response.text();
+    await fs.promises.writeFile(targetPath, content, 'utf-8');
+
+    console.log(`Schema downloaded from ${remoteFile} to ${targetPath}`);
+    return targetPath;
+  } catch (error) {
+    console.error(`Error downloading schema from ${remoteFile}:`, error);
+    throw error;
+  }
+} 

package/src/utils/index.ts

@@ -1,4 +1,5 @@
 export * from './capitalize';
+export * from './downloadSchema';
 export * from './getOperationDefinitions';
 export * from './getV3Doc';
 export * from './isQuery';

package/src/utils/isQuery.ts

@@ -1,6 +1,14 @@
 import type { EndpointOverrides, operationKeys } from '../types';
 
-export function isQuery(verb: (typeof operationKeys)[number], overrides: EndpointOverrides | undefined) {
+export function isQuery(
+  verb: (typeof operationKeys)[number],
+  path: string,
+  overrides: EndpointOverrides | undefined,
+  queryMatch?: (method: string, path: string) => boolean
+) {
+  if (queryMatch) {
+    return queryMatch(verb, path);
+  }
   if (overrides?.type) {
     return overrides.type === 'query';
   }