client-params-to-global.js

/**
 * @copyright Copyright 2020 Kevin Locke <kevin@kevinlocke.name>
 * @license MIT
 * @module "openapi-transformers/client-params-to-global.js"
 */

// Note: Undocumented function which is part of the public API:
// https://github.com/flitbit/json-ptr/issues/29
import { encodeUriFragmentIdentifier } from 'json-ptr';
import OpenApiTransformerBase from 'openapi-transformer-base';

import MatchingParameterManager from './lib/matching-parameter-manager.js';

const parameterManagerSymbol = Symbol('parameterManager');
const parametersPathSymbol = Symbol('parametersPath');

/**
 * Transformer to move parameters with x-ms-parameter-location:client defined on
 * Path Item Objects and Operation Objects to the Components or Definitions
 * Object (which is required for x-ms-parameter-location to have any effect).
 *
 * Note: Authors should define such parameters in Components or Definitions.
 * This script is mostly a workaround for api-spec-converter, which inlines
 * all $ref parameters.
 * https://github.com/Azure/autorest/tree/master/docs/extensions#x-ms-parameter-location
 */
export default class ClientParamsToGlobalTransformer
  extends OpenApiTransformerBase {
  transformParameter(parameter) {
    if (!parameter || parameter['x-ms-parameter-location'] !== 'client') {
      return parameter;
    }

    const defName = this[parameterManagerSymbol].add(parameter, parameter.name);
    return {
      $ref: encodeUriFragmentIdentifier([
        ...this[parametersPathSymbol],
        defName,
      ]),
    };
  }

  transformOpenApi(openApi) {
    if (typeof openApi !== 'object' || openApi === null || !openApi.paths) {
      return openApi;
    }

    const { components, openapi, paths } = openApi;
    if (/^3(?:\.|$)/.test(openapi)
      || (typeof components === 'object' && components !== null)) {
      const newParameters = { ...components && components.parameters };
      this[parameterManagerSymbol] =
        new MatchingParameterManager(newParameters);
      this[parametersPathSymbol] = ['components', 'parameters'];

      return {
        ...openApi,
        components: {
          ...components,
          parameters: newParameters,
        },
        paths: this.transformPaths(paths),
      };
    }

    const { parameters, swagger } = openApi;
    if (/^2(?:\.|$)/.test(swagger)
      || (typeof parameters === 'object' && parameters !== null)) {
      const newParameters = { ...parameters };
      this[parameterManagerSymbol] =
        new MatchingParameterManager(newParameters);
      this[parametersPathSymbol] = ['parameters'];

      const newOpenApi = {
        ...openApi,
        parameters: newParameters,
        paths: this.transformPaths(openApi.paths),
      };

      const xMsParameterizedHost = openApi['x-ms-parameterized-host'];
      if (xMsParameterizedHost
        && Array.isArray(xMsParameterizedHost.parameters)) {
        newOpenApi['x-ms-parameterized-host'] = {
          ...xMsParameterizedHost,
          parameters: this.transformArray(
            xMsParameterizedHost.parameters,
            this.transformParameter,
          ),
        };
      }

      return newOpenApi;
    }

    return openApi;
  }
}