com.nawforce.common.rpc.OrgAPI.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of apexlink Show documentation
Offline validation and transformation toolkit for Salesforce packages
There is a newer version: 2.3.7
/*
 [The "BSD licence"]
 Copyright (c) 2020 Kevin Jones
 All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.
 3. The name of the author may not be used to endorse or promote products
    derived from this software without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.nawforce.common.rpc

import com.nawforce.common.api.{Diagnostic, DiagnosticCategory, Location, PathLocation}
import com.nawforce.common.diagnostics.Issue
import io.github.shogowada.scala.jsonrpc.api
import io.github.shogowada.scala.jsonrpc.serializers.JSONRPCPickler.{macroRW, ReadWriter => RW}

import scala.concurrent.Future

case class APIError(message: String, stack: Array[String])

object APIError {
  implicit val rw: RW[APIError] = macroRW

  def apply(ex: Throwable): APIError = {
    new APIError(ex.getMessage, ex.getStackTrace.map(_.toString))
  }

  def apply(message: String): APIError = {
    new APIError(message, Array())
  }
}

case class AddPackageResult(error: Option[APIError], namespaces: Array[String])

object AddPackageResult {
  implicit val rw: RW[AddPackageResult] = macroRW
}

case class GetIssuesResult(issues: Array[Issue])

object GetIssuesResult {
  implicit val rw: RW[GetIssuesResult] = macroRW
  implicit val rwIssue: RW[Issue] = macroRW
  implicit val rwDiagnostic: RW[Diagnostic] = macroRW
  implicit val rwDiagnosticCategory: RW[DiagnosticCategory] = macroRW
  implicit val rwLocation: RW[Location] = macroRW
}

case class GetTypeIdentifiersResult(identifiers: Array[String])

object GetTypeIdentifiersResult {
  implicit val rw: RW[GetTypeIdentifiersResult] = macroRW
}

case class NodeData(name: String)
case class LinkData(source: Int, target: Int)
case class DependencyGraphResult(nodeData: Array[NodeData], linkData: Array[LinkData])

object DependencyGraphResult {
  implicit val rw: RW[DependencyGraphResult] = macroRW
  implicit val rwNodeData: RW[NodeData] = macroRW
  implicit val rwLinkData: RW[LinkData] = macroRW
}

case class IdentifierLocationResult(pathLocation: PathLocation)

object IdentifierLocationResult {
  implicit val rw: RW[IdentifierLocationResult] = macroRW
  implicit val rwPathLocation: RW[PathLocation] = macroRW
  implicit val rwLocation: RW[Location] = macroRW
}

trait OrgAPI {
  @api.JSONRPCMethod(name = "identifier")
  def identifier(): Future[String]

  @api.JSONRPCMethod(name = "reset")
  def reset(): Future[Unit]

  @api.JSONRPCMethod(name = "addPackage")
  def addPackage(directory: String): Future[AddPackageResult]

  @api.JSONRPCMethod(name = "getIssues")
  def getIssues(includeWarnings: Boolean, includeZombies: Boolean): Future[GetIssuesResult]

  @api.JSONRPCMethod(name = "refresh")
  def refresh(path: String, contents: Option[String]): Future[Unit]

  @api.JSONRPCMethod(name = "getTypeIdentifiers")
  def typeIdentifiers(): Future[GetTypeIdentifiersResult]

  @api.JSONRPCMethod(name = "dependencyGraph")
  def dependencyGraph(path: String, depth: Int): Future[DependencyGraphResult]

  @api.JSONRPCMethod(name = "identifierLocation")
  def identifierLocation(identifier: String): Future[IdentifierLocationResult]

  @api.JSONRPCMethod(name = "identifierForPath")
  def identifierForPath(path: String): Future[Option[String]]
}

object OrgAPI {
  def apply(quiet: Boolean): OrgAPI = new OrgAPIImpl(quiet)
}