openapi-validator-utils/validators/optionsValidation.js

OpenAPI request, parameters, headers and response validator methods

const { isPlainObject, isFunction } = require('lodash');
const { responseBuilder } = require('../utils');

/** @module Validators/optionsValidation */

const validOptions = ['ajvConfig', 'errorHandler', 'strictValidation'];

/**
 * This method validates the extra options. We only allow "ajvConfig" and "errorHandler" as
 * options to export
 * @param {object} options
 * @returns {BuilderResponse}
 */
const optionsValidation = (options = {}) => {
  if (!isPlainObject(options)) {
    return responseBuilder(false, 'Options is not a valid JSON');
  }
  const extraOption = Object.keys(options).filter(option => !validOptions.includes(option));
  if (extraOption.length > 0) {
    return responseBuilder(false, `Only this props are valid: ${validOptions.join(', ')}`);
  }
  if (options.errorHandler && !isFunction(options.errorHandler)) {
    return responseBuilder(false, 'errorHandler option must be a function');
  }
  return responseBuilder(true);
};

module.exports = optionsValidation;