Feature/arbitrary file downloads for oas 3

[Geksanit]

part of #73

• embedded files (type: string + format: byte)
• other types such as application/pdf or text/xml
• single file uploads

[dxCLA]

All committers have signed the CLA.

[kokovtsev]

@Geksanit looks like this change does not 100% cover our need; for example, I tried generating the code using the spec below

  /file:
    get:
      tags:
        - files
      operationId: getFile
      responses:
        200:
          description: succesfull operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SomeJsonObject'
            text/csv:
              schema:
                type: string

The generated code adds the Accept: application/json header to the request and uses the SomeJsonObject to decode the response. That is, it is still impossible to download a CSV file.

Let's discuss what interface should be generated for the spec above. As I see it, the consumer should be able to choose the desired response type. Looks like there are two ways:

1. Generate two separate methods:

    readonly getFileAsApplicationJson: () => Kind2<F, Error, SomeJsonObject>;
    readonly getFileAsTextCsv: () => Kind2<F, Error, string>;
   

2. Accept an additional parameter:

    readonly getFile: (params: {accept: 'application/json'}) => Kind2<F, Error, SomeJsonObject>;
    readonly getFile: (params: {accept: 'text/csv'}) => Kind2<F, Error, string>;
   

What do you think?

[Geksanit]

@kokovtsev see how the code is generated now:

type MapToResponsegetFile = { 'application/json': SomeJsonObject; 'text/csv': string };
...
readonly getFile: <A extends keyof MapToResponsegetFile = 'application/json'>(parameters?: {
accept?: A;
}) => HKT<F, MapToResponsegetFile[A]>;

[kokovtsev]

Thanks @Geksanit, looks great except for some minor things! I'm adding some comments in the code