com.jetbrains.pluginverifier.response.VerifierServiceApi.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of verifier-intellij Show documentation
JetBrains Plugin Verifier Classes for IntelliJ Platform integration with API usage detection and reporting.
The newest version!
/*
 * Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
 */

@file:Suppress("unused")

package com.jetbrains.pluginverifier.response

/*
These classes must be synced with JSON schema expected by JetBrains Marketplace.
Incompatible changes to the classes (e.g. fields renames or removals) are prohibited!
Compatible additions of new fields are allowed.
 */

enum class VerificationResultTypeDto {
  OK,
  WARNINGS,
  PROBLEMS,
  INVALID_PLUGIN,
  NON_DOWNLOADABLE,
  UNCHANGED;
}

data class FullVerificationResultDto(
  val updateId: Int,
  val ideVersion: AvailableIdeDto,
  val javaVersion: String,
  val resultType: VerificationResultTypeDto,
  val verificationVerdict: String,
  val dependenciesGraph: DependenciesGraphDto?,
  val pluginStructureWarnings: List = emptyList(),
  val pluginStructureErrors: List = emptyList(),
  val compatibilityWarnings: List = emptyList(),
  val compatibilityProblems: List = emptyList(),
  val deprecatedApiUsages: List = emptyList(),
  val experimentalApiUsages: List = emptyList(),
  val internalApiUsages: List = emptyList(),
  val overrideOnlyApiUsages: List = emptyList(),
  val nonExtendableApiUsages: List = emptyList(),
  val dynamicPluginStatus: DynamicPluginStatusDto = DynamicPluginStatusDto(false, emptyList())
)

data class AvailableIdeDto(
  val ideVersion: String,
  val releaseVersion: String?,
  val productName: String?
)

data class CompatibilityProblemDto(
  val shortDescription: String,
  val fullDescription: String,
  val problemType: String
)

enum class ApiElementTypeDto {
  CLASS,
  INTERFACE,
  ANNOTATION,
  ENUM,
  METHOD,
  CONSTRUCTOR,
  FIELD
}

data class PluginStructureWarningDto(
  val message: String
)

data class CompatibilityWarningDto(
  val message: String
)

data class PluginStructureErrorDto(
  val message: String
)

data class DeprecatedApiUsageDto(
  val apiElement: String,
  val usageLocation: String,
  val apiElementType: ApiElementTypeDto,
  val shortDescription: String,
  val fullDescription: String,
  val deprecationInfo: DeprecationInfoDto
)

data class DeprecationInfoDto(
  val forRemoval: Boolean,
  val untilVersion: String?
)

data class ExperimentalApiUsageDto(
  val apiElement: String,
  val usageLocation: String,
  val apiElementType: ApiElementTypeDto,
  val shortDescription: String,
  val fullDescription: String

)

data class InternalApiUsageDto(
  val apiElement: String,
  val usageLocation: String,
  val apiElementType: ApiElementTypeDto,
  val shortDescription: String,
  val fullDescription: String
)

data class OverrideOnlyApiUsageDto(
  val apiElement: String,
  val usageLocation: String,
  val apiElementType: ApiElementTypeDto,
  val shortDescription: String,
  val fullDescription: String
)

data class NonExtendableApiUsageDto(
  val apiElement: String,
  val usageLocation: String,
  val apiElementType: ApiElementTypeDto,
  val shortDescription: String,
  val fullDescription: String
)

data class MissingDependenciesSetDto(
  val dependencyNode: DependenciesGraphDto.DependencyNodeDto,
  val missingDependencies: Set
)

data class DependenciesGraphDto(
  val start: DependencyNodeDto,
  val vertices: List,
  val edges: List,
  val missingDependencies: List
) {

  data class DependencyNodeDto(
    val pluginId: String,
    val version: String
  )

  data class DependencyEdgeDto(
    val from: DependencyNodeDto,
    val to: DependencyNodeDto,
    val dependency: DependencyDto
  )

  data class DependencyDto(
    val dependencyId: String,
    val optional: Boolean,
    val module: Boolean
  )

  data class MissingDependencyDto(
    val dependency: DependencyDto,
    val missingReason: String
  )
}

data class DynamicPluginStatusDto(
  val dynamic: Boolean,
  val reasons: List
)