@superhero/oas/components/headers.js

OpenAPI Specification (OAS) router

import ComponentsAbstraction from './abstraction.js'
import Schemas               from './schemas.js'

/**
 * @memberof Oas.Components
 */
export default class Headers extends ComponentsAbstraction
{
  validComponentAttributes =
  [
    'description', 'required', 'deprecated', 'schema', 
    'example', 'examples', '$ref'
  ]

  constructor(specification)
  {
    super(specification)
    this.schemas = new Schemas(specification)
  }

  denormalize(component)
  {
    const denormalized = super.denormalize(component)

    if('schema' in denormalized)
    {
      denormalized.schema = this.schemas.denormalize(denormalized.schema)
    }

    return denormalized
  }

  conform(component, instance)
  {
    try
    {
      this.validateComponentAttributes(component)

      if(component.$ref)
      {
        return this.conformRef(component.$ref, instance)
      }

      if(component.required
      && undefined === instance)
      {
        const error = new Error(`Missing required header`)
        error.code  = 'E_OAS_INVALID_HEADER_INSTANCE'
        throw error
      }

      if(undefined === instance)
      {
        return instance
      }

      if(false === !!component.allowEmptyValue
      && ''    === instance)
      {
        const error = new Error(`Header is not allowed to be empty`)
        error.code  = 'E_OAS_INVALID_HEADER_INSTANCE'
        throw error
      }

      if('schema' in component)
      {
        const schema = component.schema
        return this.schemas.conform(schema, instance)
      }

      return instance
    }
    catch(reason)
    {
      const error = new Error(`Invalid header component`)
      error.code  = 'E_OAS_INVALID_HEADER'
      error.cause = reason
      throw error
    }
  }

  validateRefPointer(pointer)
  {
    super.validateRefPointer(pointer)

    if(false === pointer.startsWith('/components/headers/'))
    {
      const error = new Error(`The ref pointer "${pointer}" must point to a headers component`)
      error.code  = 'E_OAS_INVALID_HEADER_SPECIFICATION'
      throw error
    }
  }
}