webapi.BaseUnit.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of webapi-parser Show documentation
webapi-parser
There is a newer version: 0.5.0
package webapi

import webapi.WebApiClientConverters._

import amf.client.model.document.{
  BaseUnit,
  Document,
  Module,
  PayloadFragment,
  ExternalFragment,
  Vocabulary,
  Extension,
  Overlay,
  DocumentationItem,
  DataType,
  NamedExample,
  ResourceTypeFragment,
  TraitFragment,
  AnnotationTypeDeclaration,
  SecuritySchemeFragment
}
import amf.core.model.document.{
  BaseUnit => InternalBaseUnit,
  Document => InternalDocument,
  Module => InternalModule,
  PayloadFragment => InternalPayloadFragment,
  ExternalFragment => InternalExternalFragment
}
import amf.plugins.document.vocabularies.model.document.{
  Vocabulary => InternalVocabulary
}
import amf.plugins.document.webapi.model.{
  Extension => InternalExtension,
  Overlay => InternalOverlay,
  DocumentationItemFragment => InternalDocumentationItem,
  DataTypeFragment => InternalDataType,
  NamedExampleFragment => InternalNamedExample,
  ResourceTypeFragment => InternalResourceTypeFragment,
  TraitFragment => InternalTraitFragment,
  AnnotationTypeDeclarationFragment => InternalAnnotationTypeDeclaration,
  SecuritySchemeFragment => InternalSecuritySchemeFragment
}
import amf.client.model.domain.{
  ArrayNode, ObjectNode, ScalarNode, DataNode, DomainElement,
  AnyShape, NodeShape, UnionShape, ArrayShape,
  NilShape, FileShape, ScalarShape, SchemaShape
}
import amf.plugins.domain.shapes.models.{
  NodeShape => InternalNodeShape,
  UnionShape => InternalUnionShape,
  ArrayShape => InternalArrayShape,
  AnyShape => InternalAnyShape,
  NilShape => InternalNilShape,
  FileShape => InternalFileShape,
  ScalarShape => InternalScalarShape,
  SchemaShape => InternalSchemaShape
}

import scala.scalajs.js.annotation._
import collection.mutable.Map
import util.control.Breaks._


/**
  * Custom BaseUnit subclass which implements utility methods.
  */
@JSExportAll
trait WebApiBaseUnit extends BaseUnit {
  override val _internal: InternalBaseUnit

  /** Gets declaration by name.
    *
    * @param name String name of declaration to look for.
    * @return Found declaration as AnyShape.
    */
  def getDeclarationByName(name: String): AnyShape = {
    var nodesMap = Map[String, AnyShape]()
    val elements: ClientList[DomainElement] = findByType("http://a.ml/vocabularies/shapes#Shape")

    elements.asInternal foreach {
      element => {
        breakable {
          var shape = element match {
            case nos: InternalNodeShape   => new NodeShape(nos)
            case uns: InternalUnionShape  => new UnionShape(uns)
            case ars: InternalArrayShape  => new ArrayShape(ars)
            case nis: InternalNilShape    => new NilShape(nis)
            case fis: InternalFileShape   => new FileShape(fis)
            case scs: InternalScalarShape => new ScalarShape(scs)
            case shs: InternalSchemaShape => new SchemaShape(shs)
            case ans: InternalAnyShape    => new AnyShape(ans)
            case _                        => break
          }
          // Do not include references. Relies on root type declarations being
          // at the start of the findByType() results list.
          if(!(shape.isLink) && !(nodesMap.contains(shape.name.value()))) {
            nodesMap += (shape.name.value() -> shape)
          }
        }
      }
    }
    nodesMap.get(name) match {
      case Some(declaration) => declaration
      case None => throw new Exception(s"Declaration with name '$name' not found")
    }
  }
}


/** Subclass of Document inheriting WebApiBaseUnit utility methods. */
@JSExportAll
@JSExportTopLevel("webapi.WebApiDocument")
class WebApiDocument(override val _internal: InternalDocument)
    extends Document(_internal) with WebApiBaseUnit {

  @JSExportTopLevel("webapi.WebApiDocument")
  def this() = this(InternalDocument())

  @JSExportTopLevel("webapi.WebApiDocument")
  def this(encoding: DomainElement) = this(InternalDocument().withEncodes(encoding))
}


/** Subclass of Module inheriting WebApiBaseUnit utility methods. */
@JSExportAll
@JSExportTopLevel("webapi.WebApiModule")
class WebApiModule(override val _internal: InternalModule)
    extends Module(_internal) with WebApiBaseUnit {

  @JSExportTopLevel("webapi.WebApiModule")
  def this() = this(InternalModule())
}


/** Subclass of ExternalFragment inheriting WebApiBaseUnit utility methods. */
@JSExportAll
@JSExportTopLevel("webapi.WebApiExternalFragment")
class WebApiExternalFragment(override val _internal: InternalExternalFragment)
    extends ExternalFragment(_internal) with WebApiBaseUnit {

  @JSExportTopLevel("webapi.WebApiExternalFragment")
  def this() = this(InternalExternalFragment())
}


/** Subclass of Extension inheriting WebApiBaseUnit utility methods. */
@JSExportAll
@JSExportTopLevel("webapi.WebApiExtension")
class WebApiExtension(override val _internal: InternalExtension)
    extends Extension(_internal) with WebApiBaseUnit {

  @JSExportTopLevel("webapi.WebApiExtension")
  def this() = this(InternalExtension())
}


/** Subclass of Overlay inheriting WebApiBaseUnit utility methods. */
@JSExportAll
@JSExportTopLevel("webapi.WebApiOverlay")
class WebApiOverlay(override val _internal: InternalOverlay)
    extends Overlay(_internal) with WebApiBaseUnit {

  @JSExportTopLevel("webapi.WebApiOverlay")
  def this() = this(InternalOverlay())
}


/** Subclass of DocumentationItem inheriting WebApiBaseUnit utility methods. */
@JSExportAll
@JSExportTopLevel("webapi.WebApiDocumentationItem")
class WebApiDocumentationItem(override val _internal: InternalDocumentationItem)
    extends DocumentationItem(_internal) with WebApiBaseUnit {

  @JSExportTopLevel("webapi.WebApiDocumentationItem")
  def this() = this(InternalDocumentationItem())
}


/** Subclass of DataType inheriting WebApiBaseUnit utility methods. */
@JSExportAll
@JSExportTopLevel("webapi.WebApiDataType")
class WebApiDataType(override val _internal: InternalDataType)
    extends DataType(_internal) with WebApiBaseUnit {

  @JSExportTopLevel("webapi.WebApiDataType")
  def this() = this(InternalDataType())
}


/** Subclass of NamedExample inheriting WebApiBaseUnit utility methods. */
@JSExportAll
@JSExportTopLevel("webapi.WebApiNamedExample")
class WebApiNamedExample(override val _internal: InternalNamedExample)
    extends NamedExample(_internal) with WebApiBaseUnit {

  @JSExportTopLevel("webapi.WebApiNamedExample")
  def this() = this(InternalNamedExample())
}


/** Subclass of ResourceTypeFragment inheriting WebApiBaseUnit utility methods. */
@JSExportAll
@JSExportTopLevel("webapi.WebApiResourceTypeFragment")
class WebApiResourceTypeFragment(override val _internal: InternalResourceTypeFragment)
    extends ResourceTypeFragment(_internal) with WebApiBaseUnit {

  @JSExportTopLevel("webapi.WebApiResourceTypeFragment")
  def this() = this(InternalResourceTypeFragment())
}


/** Subclass of TraitFragment inheriting WebApiBaseUnit utility methods. */
@JSExportAll
@JSExportTopLevel("webapi.WebApiTraitFragment")
class WebApiTraitFragment(override val _internal: InternalTraitFragment)
    extends TraitFragment(_internal) with WebApiBaseUnit {

  @JSExportTopLevel("webapi.WebApiTraitFragment")
  def this() = this(InternalTraitFragment())
}


/** Subclass of AnnotationTypeDeclaration inheriting WebApiBaseUnit utility methods. */
@JSExportAll
@JSExportTopLevel("webapi.WebApiAnnotationTypeDeclaration")
class WebApiAnnotationTypeDeclaration(override val _internal: InternalAnnotationTypeDeclaration)
    extends AnnotationTypeDeclaration(_internal) with WebApiBaseUnit {

  @JSExportTopLevel("webapi.WebApiAnnotationTypeDeclaration")
  def this() = this(InternalAnnotationTypeDeclaration())
}


/** Subclass of SecuritySchemeFragment inheriting WebApiBaseUnit utility methods. */
@JSExportAll
@JSExportTopLevel("webapi.WebApiSecuritySchemeFragment")
class WebApiSecuritySchemeFragment(override val _internal: InternalSecuritySchemeFragment)
    extends SecuritySchemeFragment(_internal) with WebApiBaseUnit {

  @JSExportTopLevel("webapi.WebApiSecuritySchemeFragment")
  def this() = this(InternalSecuritySchemeFragment())
}


/** Subclass of PayloadFragment inheriting WebApiBaseUnit utility methods. */
@JSExportAll
@JSExportTopLevel("webapi.WebApiPayloadFragment")
class WebApiPayloadFragment(override val _internal: InternalPayloadFragment)
    extends PayloadFragment(_internal) with WebApiBaseUnit {

  @JSExportTopLevel("webapi.WebApiPayloadFragment")
  def this(scalar: ScalarNode, mediaType: String) = this(
    InternalPayloadFragment(scalar.asInstanceOf[DataNode], mediaType))

  @JSExportTopLevel("webapi.WebApiPayloadFragment")
  def this(obj: ObjectNode, mediaType: String) = this(
    InternalPayloadFragment(obj.asInstanceOf[DataNode], mediaType))

  @JSExportTopLevel("webapi.WebApiPayloadFragment")
  def this(arr: ArrayNode, mediaType: String) = this(
    InternalPayloadFragment(arr.asInstanceOf[DataNode], mediaType))
}


/** Subclass of Vocabulary inheriting WebApiBaseUnit utility methods. */
@JSExportAll
@JSExportTopLevel("webapi.WebApiVocabulary")
class WebApiVocabulary(override val _internal: InternalVocabulary)
    extends Vocabulary(_internal) with WebApiBaseUnit {

  @JSExportTopLevel("webapi.WebApiVocabulary")
  def this() = this(InternalVocabulary())
}