Support binary responses

By default this library adds a `Accept: application/json` header to
requests.
We want to signal that other content types are accepted also, eg
'application/pdf'.

Furthermore, Axios won't handle binary response data without the
`responseType` parameter set to something other than `json` (which is
the default).

Therefore, this library now set both a non-`Accept: application/json`
header (if one is not explicit defined in the spec)
and `responseType: arraybuffer` parameter for binary responses.

See https://axios-http.com/docs/req_config.

src/client/interfaces/Operation.d.ts

@@ -13,4 +13,5 @@ export interface Operation extends OperationParameters {
     errors: OperationError[];
     results: OperationResponse[];
     responseHeader: string | null;
+    responseType: 'arraybuffer' | 'document' | 'json' | 'text' | 'stream' | 'blob' | null;
 }

src/client/interfaces/OperationResponse.d.ts

@@ -3,4 +3,5 @@ import type { Model } from './Model';
 export interface OperationResponse extends Model {
     in: 'response' | 'header';
     code: number;
+    mediaType: string | null;
 }

src/openApi/v2/parser/getOperation.ts

@@ -44,6 +44,7 @@ export const getOperation = (
         errors: [],
         results: [],
         responseHeader: null,
+        responseType: 'json',
     };
 
     // Parse the operation parameters (path, query, body, etc).

src/openApi/v2/parser/getOperationResponse.ts

@@ -30,6 +30,7 @@ export const getOperationResponse = (
         enum: [],
         enums: [],
         properties: [],
+        mediaType: null,
     };
 
     // If this response has a schema, then we need to check two things:

src/openApi/v2/parser/getOperationResults.ts

@@ -39,6 +39,7 @@ export const getOperationResults = (operationResponses: OperationResponse[]): Op
             enum: [],
             enums: [],
             properties: [],
+            mediaType: null,
         });
     }
 

src/openApi/v3/parser/getOperation.ts

@@ -6,11 +6,14 @@ import type { OpenApi } from '../interfaces/OpenApi';
 import type { OpenApiOperation } from '../interfaces/OpenApiOperation';
 import type { OpenApiRequestBody } from '../interfaces/OpenApiRequestBody';
 import { getOperationErrors } from './getOperationErrors';
+import { getOperationExplicitAcceptHeader } from './getOperationExplicitAcceptHeader';
+import { getOperationImplicitAcceptHeader } from './getOperationImplicitAcceptHeader';
 import { getOperationName } from './getOperationName';
 import { getOperationParameters } from './getOperationParameters';
 import { getOperationRequestBody } from './getOperationRequestBody';
 import { getOperationResponseHeader } from './getOperationResponseHeader';
 import { getOperationResponses } from './getOperationResponses';
+import { getOperationResponseType } from './getOperationResponseType';
 import { getOperationResults } from './getOperationResults';
 import { getRef } from './getRef';
 import { getServiceName } from './getServiceName';
@@ -47,6 +50,7 @@ export const getOperation = (
         errors: [],
         results: [],
         responseHeader: null,
+        responseType: null,
     };
 
     // We want to treat query parameters and body request as a single object with all the parameters
@@ -125,6 +129,36 @@ export const getOperation = (
         const operationResults = getOperationResults(operationResponses);
         operation.errors = getOperationErrors(operationResponses);
         operation.responseHeader = getOperationResponseHeader(operationResults);
+        operation.responseType = getOperationResponseType(operationResults);
+
+        // Add 'Accept' header, if not set
+        const explicitAcceptHeader = parameters ? getOperationExplicitAcceptHeader(parameters.parametersHeader) : null;
+        if (!explicitAcceptHeader) {
+            const acceptHeader = getOperationImplicitAcceptHeader(operationResults);
+            if (acceptHeader) {
+                const acceptHeaderOperationParameter: OperationParameter = {
+                    in: 'header',
+                    prop: 'Accept',
+                    export: 'interface',
+                    name: `'${acceptHeader}'`,
+                    type: 'any',
+                    base: 'any',
+                    template: null,
+                    link: null,
+                    description: null,
+                    isDefinition: false,
+                    isReadOnly: false,
+                    isRequired: true,
+                    isNullable: false,
+                    imports: [],
+                    enum: [],
+                    enums: [],
+                    properties: [],
+                    mediaType: null,
+                };
+                operation.parametersHeader.push(acceptHeaderOperationParameter);
+            }
+        }
 
         operationResults.forEach(operationResult => {
             operation.results.push(operationResult);

src/openApi/v3/parser/getOperationExplicitAcceptHeader.ts

@@ -0,0 +1,11 @@
+import type { OperationParameter } from '../../../client/interfaces/OperationParameter';
+
+export const getOperationExplicitAcceptHeader = (operationParameters: OperationParameter[]): string | null => {
+    const header = operationParameters.find(operationParameter => {
+        return operationParameter.in === 'header' && operationParameter.name.toLowerCase() === 'accept';
+    });
+    if (header) {
+        return header.name;
+    }
+    return null;
+};

src/openApi/v3/parser/getOperationImplicitAcceptHeader.ts

@@ -0,0 +1,11 @@
+import type { OperationResponse } from '../../../client/interfaces/OperationResponse';
+
+export const getOperationImplicitAcceptHeader = (operationResponses: OperationResponse[]): string | null => {
+    const operationResponse = operationResponses.find(operationResponses => {
+        return operationResponses.in === 'response';
+    });
+    if (operationResponse) {
+        return operationResponse.mediaType;
+    }
+    return null;
+};

src/openApi/v3/parser/getOperationResponse.ts

@@ -31,11 +31,13 @@ export const getOperationResponse = (
         enum: [],
         enums: [],
         properties: [],
+        mediaType: null,
     };
 
     if (response.content) {
         const content = getContent(openApi, response.content);
         if (content) {
+            operationResponse.mediaType = content.mediaType;
             if (content.schema.$ref?.startsWith('#/components/responses/')) {
                 content.schema = getRef<OpenApiSchema>(openApi, content.schema);
             }

src/openApi/v3/parser/getOperationResponseType.ts

@@ -0,0 +1,13 @@
+import type { OperationResponse } from '../../../client/interfaces/OperationResponse';
+
+export const getOperationResponseType = (
+    operationResponses: OperationResponse[]
+): 'arraybuffer' | 'document' | 'json' | 'text' | 'stream' | 'blob' | null => {
+    const operationResponse = operationResponses.find(operationResponses => {
+        return operationResponses.in === 'response';
+    });
+    if (operationResponse) {
+        return operationResponse.format === 'binary' ? 'blob' : null; // Other cases: not implemented
+    }
+    return null;
+};

src/openApi/v3/parser/getOperationResults.ts

@@ -39,6 +39,7 @@ export const getOperationResults = (operationResponses: OperationResponse[]): Op
             enum: [],
             enums: [],
             properties: [],
+            mediaType: null,
         });
     }
 

src/templates/exportService.hbs

@@ -163,6 +163,9 @@ export abstract class {{{name}}}{{{@root.postfix}}} {
 			{{#if responseHeader}}
 			responseHeader: '{{{responseHeader}}}',
 			{{/if}}
+			{{#if responseType}}
+			responseType: '{{{responseType}}}',
+			{{/if}}
 			{{#if errors}}
 			errors: {
 				{{#each errors}}