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

package/lib/index.js

@@ -619,6 +619,7 @@ var EndpointInfoExtractor = class {
     const { queryParams, pathParams, isVoidArg, hasRequestBody } = this.extractParameters(operationDefinition);
     const contentType = this.extractContentType(operation);
     const tags = Array.isArray(operation.tags) ? operation.tags : [];
+    const isBlobResponse = this.isBlobResponseEndpoint(operation);
     return {
       operationName: finalOperationName,
       argTypeName,
@@ -633,7 +634,8 @@ var EndpointInfoExtractor = class {
       summary,
       contentType,
       hasRequestBody,
-      tags
+      tags,
+      isBlobResponse
     };
   }
   /**
@@ -667,6 +669,28 @@ var EndpointInfoExtractor = class {
     if (!parameters) return [];
     return Array.isArray(parameters) ? parameters : [parameters];
   }
+  /**
+   * 偵測是否為 Blob 下載端點
+   * 當 response content type 為 binary 類型或 schema format 為 binary 時回傳 true
+   */
+  isBlobResponseEndpoint(operation) {
+    if (!operation.responses) return false;
+    const successResponse = operation.responses["200"] || operation.responses["201"];
+    if (!successResponse?.content) return false;
+    const contentTypes = Object.keys(successResponse.content);
+    const textContentTypes = ["application/json", "text/", "*/*"];
+    const hasNonTextContentType = contentTypes.some(
+      (ct) => !textContentTypes.some((textCt) => ct === textCt || ct.startsWith(textCt))
+    );
+    if (hasNonTextContentType) return true;
+    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 - 操作對象
@@ -707,10 +731,15 @@ function generateTypesFile(endpointInfos, _options, schemaInterfaces, operationD
       }
     });
   }
+  const hasBlobResponse = endpointInfos.some((info) => info.isBlobResponse);
   let importStatement = `/* eslint-disable */
-// [Warning] Generated automatically - do not edit manually 
-  
+// [Warning] Generated automatically - do not edit manually
+
+`;
+  if (hasBlobResponse) {
+    importStatement += `import { HttpResponse } from '@angular/common/http';
 `;
+  }
   const hasSchemaTypes = schemaInterfaces && Object.keys(schemaInterfaces).length > 0;
   if (hasSchemaTypes) {
     importStatement += `import * as Schema from "../schema";
@@ -731,11 +760,15 @@ function generateTypesFile(endpointInfos, _options, schemaInterfaces, operationD
       }
     }
     if (resTypeName) {
-      const responseTypeContent = generateResponseTypeContent(endpoint, operationDefinitions, schemaTypeMap);
-      if (responseTypeContent.trim() === "") {
-        endpointTypes.push(`export type ${resTypeName} = void;`, ``);
+      if (endpoint.isBlobResponse) {
+        endpointTypes.push(`export type ${resTypeName} = HttpResponse<Blob>;`, ``);
       } else {
-        endpointTypes.push(`export type ${resTypeName} = {`, responseTypeContent, `};`, ``);
+        const responseTypeContent = generateResponseTypeContent(endpoint, operationDefinitions, schemaTypeMap);
+        if (responseTypeContent.trim() === "") {
+          endpointTypes.push(`export type ${resTypeName} = void;`, ``);
+        } else {
+          endpointTypes.push(`export type ${resTypeName} = {`, responseTypeContent, `};`, ``);
+        }
       }
     }
   });
@@ -939,7 +972,7 @@ function generateRtkQueryFile(endpointInfos, options) {
   /**
    * ${info.summary}
    */
-  ${info.operationName}Query(args: IRestFulEndpointsQueryReturn<${info.argTypeName}>, queryOptions?: QueryOptions): Observable<QueryState<${info.responseTypeName}>> {
+  ${info.operationName}Query(args: IRestFulEndpointsQueryReturn<${info.argTypeName}>, queryOptions?: BaseQueryOptions): Observable<QueryState<${info.responseTypeName}>> {
     if (queryOptions?.skip) {
       return this.ntkQuery.skipQuery<${info.responseTypeName}>();
     }
@@ -989,7 +1022,7 @@ function generateRtkQueryFile(endpointInfos, options) {
 import {Injectable, inject} from '@angular/core';
 import {Observable} from 'rxjs';
 import {HttpErrorResponse} from '@angular/common/http';
-import {NtkQueryService, MutationState, QueryState, QueryOptions, MutationResponse, LazyQueryResult, LazyQueryTriggerOptions} from '@core/ntk-query';
+import {NtkQueryService, MutationState, QueryState, BaseQueryOptions, MutationResponse, LazyQueryResult, LazyQueryTriggerOptions} from '@core/ntk-query';
 import {ECacheTagTypes} from '../tagTypes';
 import {${apiServiceName}} from './enhanceEndpoints';
 import {IRestFulEndpointsQueryReturn, RequestOptions} from '../common-types';
@@ -1050,10 +1083,13 @@ ${endpointInfos.map((info) => {
         const paramsLines = info.queryParams.map((param) => `${param.name}: args.variables.${param.name},`).join("\n");
         paramsSection = `params: {${paramsLines}},`;
       }
+      const blobOptions = info.isBlobResponse ? `
+        responseType: 'blob',
+        observe: 'response',` : "";
       return `{
         ...args?.fetchOptions,
         headers: { 'Content-Type': '${info.contentType}', ...args?.fetchOptions?.headers },
-        ${paramsSection}${info.hasRequestBody ? `body: args.variables.body,` : ""}
+        ${paramsSection}${info.hasRequestBody ? `body: args.variables.body,` : ""}${blobOptions}
       }`;
     };
     return `