binary-string-to-file.js

/**
 * @copyright Copyright 2019 Kevin Locke <kevin@kevinlocke.name>
 * @license MIT
 * @module "openapi-transformers/binary-string-to-file.js"
 */

import OpenApiTransformerBase from 'openapi-transformer-base';

function transformSchemaType(schema) {
  if (schema.type === 'string'
      && (schema.format === 'binary' || schema.format === 'file')) {
    const newSchema = {
      ...schema,
      type: 'file',
    };
    delete newSchema.format;
    return newSchema;
  }

  return schema;
}

/**
 * Transformer to replace `type: string, format: binary` (or `format: file`)
 * with `type: file` so that Autorest generates to a Stream instead of string.
 */
export default class BinaryStringToFileTransformer
  extends OpenApiTransformerBase {
  // eslint-disable-next-line class-methods-use-this
  transformSchema(schema) {
    // Don't call super, since `type: file` is only allowed on root schema of
    // response.
    // Note: No checking is done to enforce this (due to $ref complications).
    // Note: A response could $ref a property schema.  Unlikely.
    return transformSchemaType(schema);
  }

  // eslint-disable-next-line class-methods-use-this
  transformParameter(parameter) {
    if (parameter === null || typeof parameter !== 'object') {
      return parameter;
    }

    let newParameter = transformSchemaType(parameter);
    if (newParameter.schema) {
      newParameter = {
        ...newParameter,
        schema: transformSchemaType(newParameter.schema),
      };
    }

    return newParameter;
  }
}