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

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

@@ -20,11 +20,15 @@ export interface QueryConfig {
     keepUnusedDataFor?: number,
 }
 
+export interface IRequestConfig extends RequestOptions { {
+  timeout?: number;
+}
+
 export type IRestFulEndpointsQueryReturn<TVariables> = TVariables extends void ? 
-  void | {fetchOptions?: RequestOptions;config?: QueryConfig;}: 
+  void | {fetchOptions?: IRequestConfig;}: 
   {
       variables: TVariables;
-      fetchOptions?: RequestOptions;
+      fetchOptions?: IRequestConfig;
       config?: QueryConfig;
   };
 `;

package/src/generators/component-schema-generator.ts

@@ -1,5 +1,25 @@
 import ts from 'typescript';
 
+/**
+ * 轉換類型名稱為大駝峰命名
+ */
+function toPascalCase(name: string): string {
+  return name.charAt(0).toUpperCase() + name.slice(1);
+}
+
+/**
+ * 重新命名 TypeScript 節點中的標識符
+ */
+function renameIdentifier(node: ts.Node, oldName: string, newName: string): ts.Node {
+  return ts.transform(node, [
+    context => rootNode => ts.visitNode(rootNode, function visit(node): ts.Node {
+      if (ts.isIdentifier(node) && node.text === oldName) {
+        return ts.factory.createIdentifier(newName);
+      }
+      return ts.visitEachChild(node, visit, context);
+    })
+  ]).transformed[0];
+}
 
 /**
  * 產生 component-schema.ts 內容
@@ -7,7 +27,7 @@ import ts from 'typescript';
  */
 export function generateComponentSchemaFile(interfaces: Record<string, ts.InterfaceDeclaration | ts.TypeAliasDeclaration>) {
   const printer = ts.createPrinter({ newLine: ts.NewLineKind.LineFeed });
-  
+
   const resultFile = ts.createSourceFile(
     'component-schema.ts',
     '',
@@ -16,10 +36,23 @@ export function generateComponentSchemaFile(interfaces: Record<string, ts.Interf
     ts.ScriptKind.TS
   );
 
-  // 分析接口內容以找出需要從 shared-types 導入的類型
+  // 處理類型名稱轉換為大駝峰，並建立映射表
+  const renamedInterfaces: Array<string> = [];
+  const typeNameMapping: Record<string, string> = {};
+
+  Object.entries(interfaces).forEach(([originalName, node]) => {
+    const pascalCaseName = toPascalCase(originalName);
+    typeNameMapping[originalName] = pascalCaseName;
+
+    // 重新命名節點
+    const renamedNode = renameIdentifier(node, originalName, pascalCaseName);
+    const printed = printer.printNode(ts.EmitHint.Unspecified, renamedNode, resultFile);
+    renamedInterfaces.push(printed);
+  });
+
   return `/* eslint-disable */
-// [Warning] Generated automatically - do not edit manually 
-    
-${Object.values(interfaces).map(i => printer.printNode(ts.EmitHint.Unspecified, i, resultFile)).join('\n')}
-`
-}
+// [Warning] Generated automatically - do not edit manually
+
+${renamedInterfaces.join('\n')}
+`;
+}

package/src/generators/do-not-modify-generator.ts

@@ -1,6 +1,6 @@
 /**
  * 產生 DO_NOT_MODIFY.md 說明檔案
- * 
+ *
  * 此檔案用於提醒開發者不要修改產生器生成的程式碼
  */
 export function generateDoNotModifyFile(): string {
@@ -24,4 +24,4 @@ export function generateDoNotModifyFile(): string {
 
 如有疑問，請參考專案文件或聯繫開發團隊。
 `;
-}
+}

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

@@ -0,0 +1,113 @@
+import type { GenerationOptions } from '../types';
+
+export function generateRtkEnhanceEndpointsFile(
+  endpointInfos: Array<{
+    operationName: string;
+    argTypeName: string;
+    responseTypeName: string;
+    isQuery: boolean;
+    verb: string;
+    path: string;
+    queryKeyName: string;
+    queryParams: any[];
+    pathParams: any[];
+    isVoidArg: boolean;
+    hasRequestBody: 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';
+    const hasRequestBody = info.hasRequestBody;
+
+    // 生成 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;
+
+    // 生成 HTTP 請求選項
+    const generateRequestOptions = () => {
+      const options = ['...args.fetchOptions'];
+
+      // 添加 Content-Type header，特別是對於有 body 的請求
+      if (hasRequestBody || !isGet) {
+        options.push(`headers: { 'Content-Type': 'application/json', ...args.fetchOptions?.headers }`);
+      }
+
+      if (hasQueryParams && hasArgs) {
+        options.push(generateQueryParams(info.queryParams));
+      }
+
+      if (hasRequestBody) {
+        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/{query-service-generator.ts → rtk-query-generator.ts}

@@ -1,34 +1,38 @@
 import type { GenerationOptions } from '../types';
 
-export function generateQueryServiceFile(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) {
-
+export function generateRtkQueryFile(
+  endpointInfos: Array<{
+    operationName: string;
+    argTypeName: string;
+    responseTypeName: string;
+    isQuery: boolean;
+    verb: string;
+    path: string;
+    queryKeyName: string;
+    queryParams: any[];
+    pathParams: any[];
+    isVoidArg: boolean;
+    summary: string;
+    contentType: string;
+    hasRequestBody: boolean;
+    tags: string[];
+  }>,
+  options: GenerationOptions
+) {
   const { groupKey, refetchOnMountOrArgChange = 60 } = options;
-  
+
   // 確定服務名稱 - 使用 groupKey 如果有提供的話
-  const queryServiceName = groupKey ?
-    `${groupKey.charAt(0).toUpperCase() + groupKey.slice(1)}QueryService` :
-    'QueryService';
-  
-  const apiServiceName = groupKey ? 
-    `${groupKey.charAt(0).toUpperCase() + groupKey.slice(1)}ApiService` :
-    'ApiService';
+  const queryServiceName = groupKey
+    ? `${groupKey.charAt(0).toUpperCase() + groupKey.slice(1)}QueryService`
+    : 'QueryService';
+
+  const apiServiceName = groupKey ? `${groupKey.charAt(0).toUpperCase() + groupKey.slice(1)}ApiService` : 'ApiService';
 
   // 分別處理 Query 和 Mutation 方法
   const queryMethods = endpointInfos
-    .filter(info => info.isQuery)
-    .map(info => `
+    .filter((info) => info.isQuery)
+    .map(
+      (info) => `
   /**
    * ${info.summary}
    */
@@ -41,11 +45,14 @@ export function generateQueryServiceFile(endpointInfos: Array<{
       fetchOptions: args?.fetchOptions,
       config: args?.config,
     })${info.argTypeName !== 'VoidApiArg' ? '(args)' : '()'};
-  }`).join('');
+  }`
+    )
+    .join('');
 
   const mutationMethods = endpointInfos
-    .filter(info => !info.isQuery)
-    .map(info => `
+    .filter((info) => !info.isQuery)
+    .map(
+      (info) => `
   /**
    * ${info.summary}
    */
@@ -59,11 +66,14 @@ export function generateQueryServiceFile(endpointInfos: Array<{
         return this.apiService.${info.operationName}(${info.argTypeName !== 'VoidApiArg' ? 'args' : ''});
       },
     });
-  }`).join('');
+  }`
+    )
+    .join('');
 
   const lazyQueryMethods = endpointInfos
-    .filter(info => info.isQuery)
-    .map(info => `
+    .filter((info) => info.isQuery)
+    .map(
+      (info) => `
   /**
    * ${info.summary}
    */
@@ -82,7 +92,9 @@ export function generateQueryServiceFile(endpointInfos: Array<{
         return this.apiService.${info.operationName}(${info.argTypeName !== 'VoidApiArg' ? 'args' : ''});
       }
     };
-  }`).join('');
+  }`
+    )
+    .join('');
 
   return `/* eslint-disable */
 // [Warning] Generated automatically - do not edit manually 
@@ -94,7 +106,7 @@ import {NtkQueryService, MutationState, QueryState, MutationResponse} from '@cor
 import {ECacheKeys} from '../cache-keys';
 import {${apiServiceName}} from './api.service';
 import {IRestFulEndpointsQueryReturn, RequestOptions} from '../common-types';
-import {${endpointInfos.map(info => ` ${info.argTypeName}, ${info.responseTypeName}`).join(',')}} from './types';
+import {${endpointInfos.map((info) => ` ${info.argTypeName}, ${info.responseTypeName}`).join(',')}} from './types';
 
 @Injectable({
   providedIn: 'root',
@@ -105,4 +117,4 @@ export class ${queryServiceName} {
 ${queryMethods}${mutationMethods}${lazyQueryMethods}
 }
 `;
-}
+}

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

@@ -0,0 +1,30 @@
+/**
+ * 生成 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
+
+export enum ECacheTagTypes {
+}
+`;
+  }
+
+  // 生成枚举项
+  const enumEntries = tags
+    .sort() // 按字母顺序排序
+    .map(tag => `    ${tag} = '${tag}',`)
+    .join('\n');
+
+  return `/* eslint-disable */
+// [Warning] Generated automatically - do not edit manually
+
+export enum ECacheTagTypes {
+${enumEntries}
+}
+`;
+}