@bitstack/ng-query-codegen-openapi 0.0.38-alpha.3 → 0.0.38-alpha.4

package/src/generators/types-generator.ts

@@ -20,6 +20,7 @@ export interface EndpointInfo {
   pathParams: any[];
   isVoidArg: boolean;
   summary: string;
+  isBlobResponse?: boolean;
 }
 
 export function generateTypesFile(
@@ -50,12 +51,20 @@ export function generateTypesFile(
     });
   }
 
+  // 檢查是否有 blob response 端點
+  const hasBlobResponse = endpointInfos.some((info) => info.isBlobResponse);
+
   // 生成 import 語句
   let importStatement = `/* eslint-disable */
-// [Warning] Generated automatically - do not edit manually 
-  
+// [Warning] Generated automatically - do not edit manually
+
 `;
 
+  // 如果有 blob response，加入 HttpResponse import
+  if (hasBlobResponse) {
+    importStatement += `import { HttpResponse } from '@angular/common/http';\n`;
+  }
+
   // 檢查是否需要引入 schema.ts
   const hasSchemaTypes = schemaInterfaces && Object.keys(schemaInterfaces).length > 0;
   if (hasSchemaTypes) {
@@ -93,13 +102,18 @@ export function generateTypesFile(
 
     // 生成 Response 類型（總是生成）
     if (resTypeName) {
-      const responseTypeContent = generateResponseTypeContent(endpoint, operationDefinitions, schemaTypeMap);
-      if (responseTypeContent.trim() === '') {
-        // 如果沒有實際內容，使用 void
-        endpointTypes.push(`export type ${resTypeName} = void;`, ``);
+      if (endpoint.isBlobResponse) {
+        // Blob 下載端點：使用 HttpResponse<Blob>
+        endpointTypes.push(`export type ${resTypeName} = HttpResponse<Blob>;`, ``);
       } else {
-        // 有實際內容，使用 type 定義
-        endpointTypes.push(`export type ${resTypeName} = {`, responseTypeContent, `};`, ``);
+        const responseTypeContent = generateResponseTypeContent(endpoint, operationDefinitions, schemaTypeMap);
+        if (responseTypeContent.trim() === '') {
+          // 如果沒有實際內容，使用 void
+          endpointTypes.push(`export type ${resTypeName} = void;`, ``);
+        } else {
+          // 有實際內容，使用 type 定義
+          endpointTypes.push(`export type ${resTypeName} = {`, responseTypeContent, `};`, ``);
+        }
       }
     }
   });

package/src/services/endpoint-info-extractor.ts

@@ -21,6 +21,7 @@ export interface EndpointInfo {
   contentType: string;
   hasRequestBody: boolean;
   tags: string[];
+  isBlobResponse: boolean;
 }
 
 /**
@@ -84,6 +85,9 @@ export class EndpointInfoExtractor {
     // 提取 tags
     const tags = Array.isArray(operation.tags) ? operation.tags : [];
 
+    // 偵測是否為 Blob 下載端點
+    const isBlobResponse = this.isBlobResponseEndpoint(operation);
+
     return {
       operationName: finalOperationName,
       argTypeName,
@@ -99,6 +103,7 @@ export class EndpointInfoExtractor {
       contentType,
       hasRequestBody,
       tags,
+      isBlobResponse,
     };
   }
 
@@ -144,6 +149,36 @@ export class EndpointInfoExtractor {
     return Array.isArray(parameters) ? parameters : [parameters];
   }
 
+  /**
+   * 偵測是否為 Blob 下載端點
+   * 當 response content type 為 binary 類型或 schema format 為 binary 時回傳 true
+   */
+  private isBlobResponseEndpoint(operation: any): boolean {
+    if (!operation.responses) return false;
+
+    const successResponse = operation.responses['200'] || operation.responses['201'];
+    if (!successResponse?.content) return false;
+
+    const contentTypes = Object.keys(successResponse.content);
+
+    // 非 JSON/text 類型的 content type 視為 binary（如 application/zip, application/pdf, image/*, application/vnd.* 等）
+    const textContentTypes = ['application/json', 'text/', '*/*'];
+    const hasNonTextContentType = contentTypes.some(
+      (ct) => !textContentTypes.some((textCt) => ct === textCt || ct.startsWith(textCt))
+    );
+    if (hasNonTextContentType) return true;
+
+    // 檢查 schema 是否為 binary format
+    for (const ct of contentTypes) {
+      const schema = successResponse.content[ct]?.schema;
+      if (schema && schema.type === 'string' && schema.format === 'binary') {
+        return true;
+      }
+    }
+
+    return false;
+  }
+
   /**
    * 提取操作的 content type
    * @param operation - 操作對象