add intra-stack api types

Author: Foxcapades

build.gradle.kts

@@ -5,7 +5,7 @@ plugins {
 }
 
 group = "org.veupathdb.vdi"
-version = "10.0.1"
+version = "10.1.0"
 description = "Common components for VDI projects"
 
 repositories {
@@ -25,10 +25,10 @@ configurations.all {
 }
 
 dependencies {
-  implementation("org.veupathdb.vdi:vdi-component-json:1.0.0")
+  implementation("org.veupathdb.vdi:vdi-component-json:1.0.2")
 
   implementation("org.unbroken-dome.base62:base62:1.1.0")
-  implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.3")
+  implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.8.0")
   implementation("org.apache.commons:commons-compress:1.26.1")
 
   testImplementation("org.junit.jupiter:junit-jupiter-api:5.9.2")

src/main/kotlin/org/veupathdb/vdi/lib/common/intra/common.kt

@@ -0,0 +1,7 @@
+package org.veupathdb.vdi.lib.common.intra
+
+import com.fasterxml.jackson.annotation.JsonProperty
+
+data class SimpleErrorResponse(@JsonProperty(JSONKeys.Message) val message: String)
+
+data class WarningResponse(@JsonProperty(JSONKeys.Warnings) val warnings: Collection<String>)

src/main/kotlin/org/veupathdb/vdi/lib/common/intra/import.kt

@@ -0,0 +1,11 @@
+package org.veupathdb.vdi.lib.common.intra
+
+import com.fasterxml.jackson.annotation.JsonProperty
+import org.veupathdb.vdi.lib.common.field.DatasetID
+import org.veupathdb.vdi.lib.common.model.VDIDatasetMeta
+
+data class ImportRequest(
+  @JsonProperty(JSONKeys.VDIID) val vdiID: DatasetID,
+  @JsonProperty(JSONKeys.JobID) val jobID: ULong,
+  @JsonProperty(JSONKeys.Meta)  val meta: VDIDatasetMeta,
+)

src/main/kotlin/org/veupathdb/vdi/lib/common/intra/install.kt

@@ -0,0 +1,19 @@
+package org.veupathdb.vdi.lib.common.intra
+
+import com.fasterxml.jackson.annotation.JsonProperty
+import org.veupathdb.vdi.lib.common.field.DatasetID
+import org.veupathdb.vdi.lib.common.field.ProjectID
+import org.veupathdb.vdi.lib.common.model.VDIDatasetMeta
+
+data class InstallDataRequest(
+  @JsonProperty(JSONKeys.VDIID)     val vdiID: DatasetID,
+  @JsonProperty(JSONKeys.JobID)     val jobID: ULong,
+  @JsonProperty(JSONKeys.ProjectID) val projectID: ProjectID,
+)
+
+data class InstallMetaRequest(
+  @JsonProperty(JSONKeys.VDIID)     val vdiID: DatasetID,
+  @JsonProperty(JSONKeys.JobID)     val jobID: ULong,
+  @JsonProperty(JSONKeys.ProjectID) val projectID: ProjectID,
+  @JsonProperty(JSONKeys.Meta)      val meta: VDIDatasetMeta,
+)

src/main/kotlin/org/veupathdb/vdi/lib/common/intra/json.kt

@@ -0,0 +1,10 @@
+package org.veupathdb.vdi.lib.common.intra
+
+internal object JSONKeys {
+  const val JobID = "jobID"
+  const val Message = "message"
+  const val Meta = "meta"
+  const val ProjectID = "projectID"
+  const val VDIID = "vdiID"
+  const val Warnings = "warnings"
+}

src/main/kotlin/org/veupathdb/vdi/lib/common/intra/package.md

@@ -0,0 +1,4 @@
+# Package org.veupathdb.vdi.lib.common.intra
+
+This package contains type and utility definitions used for intra-stack
+communication between VDI components.

src/main/kotlin/org/veupathdb/vdi/lib/common/intra/uninstall.kt

@@ -0,0 +1,11 @@
+package org.veupathdb.vdi.lib.common.intra
+
+import com.fasterxml.jackson.annotation.JsonProperty
+import org.veupathdb.vdi.lib.common.field.DatasetID
+import org.veupathdb.vdi.lib.common.field.ProjectID
+
+data class UninstallRequest(
+  @JsonProperty(JSONKeys.VDIID)     val vdiID: DatasetID,
+  @JsonProperty(JSONKeys.JobID)     val jobID: ULong,
+  @JsonProperty(JSONKeys.ProjectID) val projectID: ProjectID,
+)