@bitstack/ng-query-codegen-openapi 0.0.30 → 0.0.31-alpha.0

package/src/types.ts

@@ -3,22 +3,13 @@ import type { OpenAPIV3 } from 'openapi-types';
 import ts from 'typescript';
 
 // 重新匯出服務相關類型
-export type { 
-  GroupConfig,
-  GroupInfo 
-} from './services/group-service';
+export type { GroupConfig, GroupInfo } from './services/group-service';
 
-export type { 
-  FileWriteResult 
-} from './services/file-writer-service';
-
-export type {
-  EndpointCacheKey
-} from './services/unified-code-generator';
+export type { FileWriteResult } from './services/file-writer-service';
 
 export type {
   UnifiedGenerationOptions as EndpointGenerationOptions,
-  UnifiedGenerationResult as EndpointGenerationResult
+  UnifiedGenerationResult as EndpointGenerationResult,
 } from './services/unified-code-generator';
 
 export type OperationDefinition = {
@@ -69,12 +60,12 @@ export interface CommonOptions {
     importName: string;
   };
   /**
-   * HttpClient for WebApiConfiguration import
+   * HTTP client configuration for API calls
    * defaults to { file: "@core/httpClient/webapi/webapi-http-client.providers", importName: "WEBAPI_HTTP_CLIENT" }
    */
   httpClient?: {
     file: string;
-    importName: string;
+    importReturnTypeName: string; // 用於指定別名導入，例如 IRestFulEndpointsQueryReturn
   };
   /**
    * defaults to "enhancedApi"
@@ -94,9 +85,9 @@ export interface CommonOptions {
   operationNameSuffix?: string;
   /**
    * defaults to `false`
-   * `true` will generate hooks for queries and mutations, but no lazyQueries
+   * `true` will generate lazy query hooks (useLazy prefix) for query endpoints
    */
-  hooks?: boolean | { queries: boolean; lazyQueries: boolean; mutations: boolean };
+  useLazyQueries?: boolean;
   /**
    * defaults to false
    * `true` will generate a union type for `undefined` properties like: `{ id?: string | undefined }` instead of `{ id?: string }`
@@ -151,11 +142,6 @@ export interface CommonOptions {
    * File path for importing IRestFulEndpointsQueryReturn type
    */
   endpointsQueryReturnTypeFile?: string;
-  /**
-   * defaults to 60 (seconds)
-   * Number of seconds to wait before refetching data when component mounts or args change
-   */
-  refetchOnMountOrArgChange?: number;
 }
 
 export type TextMatcher = string | RegExp | (string | RegExp)[];
@@ -173,11 +159,6 @@ export interface OutputFileOptions extends Partial<CommonOptions> {
   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
-   */
-  useEnumType?: boolean;
   sharedTypesFile?: string;
   /**
    * groupKey for service class naming, e.g., "room" -> "RoomService"
@@ -204,30 +185,23 @@ export type ConfigFile =
   | Id<
       Omit<CommonOptions, 'outputFile'> & {
         // outputFiles: { [outputFile: string]: Omit<OutputFileOptions, 'outputFile'> };
-        outputFiles: OutputFilesConfig
+        outputFiles: OutputFilesConfig;
       }
     >;
 
 export type GenerateApiResult = {
   operationNames: string[];
+  tags: string[]; // 收集到的所有 tags
   files: {
     types: string;
-    apiService: string;
-    queryService: string;
+    queryService: string; // RTK Query generated file
     index: string;
+    enhanceEndpoints?: string; // RTK Query enhance endpoints file
     commonTypes?: string;
-    cacheKeys?: string;
     componentSchema?: string;
-    allEndpointCacheKeys?: Array<{
-      operationName: string
-      queryKeyName: string
-      groupKey: string
-    }>;
   };
 };
 
-
-
 export type QueryArgDefinition = {
   name: string;
   originalName: string;
@@ -236,13 +210,13 @@ export type QueryArgDefinition = {
   param?: OpenAPIV3.ParameterObject;
 } & (
   | {
-  origin: 'param';
-  param: OpenAPIV3.ParameterObject;
-}
+      origin: 'param';
+      param: OpenAPIV3.ParameterObject;
+    }
   | {
-  origin: 'body';
-  body: OpenAPIV3.RequestBodyObject;
-}
-  );
+      origin: 'body';
+      body: OpenAPIV3.RequestBodyObject;
+    }
+);
 
-export type QueryArgDefinitions = Record<string, QueryArgDefinition>;
+export type QueryArgDefinitions = Record<string, QueryArgDefinition>;

package/src/generators/api-service-generator.ts

@@ -1,112 +0,0 @@
-import type { GenerationOptions } from '../types';
-
-export function generateApiServiceFile(endpointInfos: Array<{
-  operationName: string;
-  argTypeName: string;
-  responseTypeName: string;
-  isQuery: boolean;
-  verb: string;
-  path: string;
-  queryKeyName: string;
-  queryParams: any[];
-  pathParams: any[];
-  isVoidArg: boolean;
-  summary: string;
-}>, options: GenerationOptions) {
-  
-  const { apiConfiguration, httpClient, groupKey } = options;
-  
-  // 確定服務名稱，使用業務名稱
-  const apiServiceClassName = groupKey ? 
-    `${groupKey.charAt(0).toUpperCase() + groupKey.slice(1)}ApiService` :
-    'ApiService';
-
-  return `/* eslint-disable */
-// [Warning] Generated automatically - do not edit manually 
-  
-import { ${httpClient!.importName} } from '${httpClient!.file}';
-import { Injectable, inject } from '@angular/core';
-import { Observable } from 'rxjs';
-import { ${apiConfiguration!.importName} } from '${apiConfiguration!.file}';
-import { RequestOptions, IRestFulEndpointsQueryReturn } from '../common-types';
-import { withoutUndefined } from '../utils';
-import {${endpointInfos.map(info => ` ${info.argTypeName}, ${info.responseTypeName}`).join(',')} } from './types';
-
-@Injectable({
-  providedIn: 'root',
-})
-export class ${apiServiceClassName} {
-  private config = inject(${apiConfiguration!.importName});
-  private http = inject(${httpClient!.importName});
-
-${endpointInfos.map(info => {
-  const isGet = info.verb.toUpperCase() === 'GET';
-  const hasArgs = info.argTypeName !== 'VoidApiArg';
-  
-  // 生成 URL 模板字面量，直接替換路徑參數
-  const generateUrlTemplate = (path: string) => {
-    const hasPathParams = path.includes('{');
-    if (hasPathParams && hasArgs) {
-      // 將 {paramName} 替換為 ${args.variables.paramName}
-      const urlTemplate = path.replace(/\{([^}]+)\}/g, '${args.variables.$1}');
-      return `\`\${this.config.rootUrl}${urlTemplate}\``;
-    } else {
-      return `\`\${this.config.rootUrl}${path}\``;
-    }
-  };
-  
-  const hasQueryParams = info.queryParams.length > 0;
-  const hasBody = !isGet && hasArgs && !info.isVoidArg;
-  
-  // 生成 HTTP 請求選項
-  const generateRequestOptions = () => {
-    const options = [
-      '...args.fetchOptions',
-    ];
-
-    // 添加 Content-Type header，特別是對於有 body 的請求
-    if (hasBody || !isGet) {
-      options.push(`headers: { 'Content-Type': 'application/json', ...args.fetchOptions?.headers }`);
-    }
-
-    if (hasQueryParams && hasArgs) {
-      options.push(generateQueryParams(info.queryParams));
-    }
-
-    if (hasBody) {
-      options.push('body: args.variables.body');
-    }
-
-    return options.length > 0 ? `{ ${options.join(', ')} }` : '{}';
-  };
-
-    return `
-  /**
-   * ${info.summary}
-   */
-  ${info.operationName}(
-    ${hasArgs ? `args: IRestFulEndpointsQueryReturn<${info.argTypeName}>, ` : ''}
-  ): Observable<${info.responseTypeName}> {
-    const url = ${generateUrlTemplate(info.path)};
-    return this.http.request('${info.verb.toLowerCase()}', url, ${generateRequestOptions()});
-  }`;
-  
-  
-  
-}).join('')}
-}
-`;
-}
-
-
-/**
- * 產生 QueryParams 參數
- * @param queryParams
- */
-function generateQueryParams(queryParams: Record<string, string>[]) {
-  const paramEntries = queryParams.map(param =>
-    `${param.name}: args.variables.${param.name}`
-  ).join(', ');
-
-  return `params: withoutUndefined({ ${paramEntries} })`;
-}

package/src/generators/cache-keys-generator.ts

@@ -1,43 +0,0 @@
-import { toCamelCase } from './utils-generator';
-
-
-export function generateCacheKeysFile(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}>>);
-
-  // 生成 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 `${groupComment}\n${keyEntries}`;
-  }).join('\n\n');
-
-  return `// [Warning] Generated automatically - do not edit manually 
-  
-/**
- * Cache keys enum for all API queries
- */
-export enum ECacheKeys {
-${enumEntries}
-}
-
-export default ECacheKeys;
-`;
-}

package/src/generators/index-generator.ts

@@ -1,11 +0,0 @@
-import type { GenerationOptions } from '../types';
-
-export function generateIndexFile(groupKey: string, options: GenerationOptions) {
-  const { groupKey: optionsGroupKey } = options;
-  
-
-  return `export * from './types';
-export * from './api.service';
-export * from './query.service';
-`;
-}

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

@@ -1,24 +0,0 @@
-import type { GenerationOptions } from '../types';
-import { generateApiServiceFile } from '../generators/api-service-generator';
-
-/**
- * API 服務程式碼生成器 - 專門負責生成 API Service 相關程式碼
- */
-export class ApiServiceGenerator {
-  constructor(private options: GenerationOptions) {}
-
-  /**
-   * 生成 API Service 檔案內容
-   */
-  generateApiService(endpointInfos: Array<any>): string {
-    const generatorOptions = {
-      ...this.options,
-      apiConfiguration: this.options.apiConfiguration || { 
-        file: '@/store/webapi', 
-        importName: 'WebApiConfiguration' 
-      }
-    };
-
-    return generateApiServiceFile(endpointInfos, generatorOptions);
-  }
-}

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

@@ -1,24 +0,0 @@
-import type { GenerationOptions } from '../types';
-import { generateQueryServiceFile } from '../generators/query-service-generator';
-
-/**
- * Query 服務程式碼生成器 - 專門負責生成 Query Service 相關程式碼
- */
-export class QueryCodeGenerator {
-  constructor(private options: GenerationOptions) {}
-
-  /**
-   * 生成 Query Service 檔案內容
-   */
-  generateQueryService(endpointInfos: Array<any>): string {
-    const generatorOptions = {
-      ...this.options,
-      apiConfiguration: this.options.apiConfiguration || { 
-        file: '@/store/webapi', 
-        importName: 'WebApiConfiguration' 
-      }
-    };
-
-    return generateQueryServiceFile(endpointInfos, generatorOptions);
-  }
-}