feat: support operation templates

Author: jwilkinson87

src/main/kotlin/com/ctrlhub/core/governance/schemes/workorders/operations/templates/OperationTemplatesRouter.kt

@@ -0,0 +1,23 @@
+package com.ctrlhub.core.governance.schemes.workorders.operations.templates
+
+import com.ctrlhub.core.Api
+import com.ctrlhub.core.governance.schemes.workorders.operations.OperationsRouter
+import com.ctrlhub.core.governance.schemes.workorders.operations.templates.response.OperationTemplate
+import com.ctrlhub.core.router.Router
+import io.ktor.client.HttpClient
+
+class OperationTemplatesRouter(httpClient: HttpClient) : Router(httpClient) {
+    suspend fun all(organisationId: String): List<OperationTemplate> {
+        return fetchJsonApiResources("/v3/orgs/$organisationId/governance/operation-templates")
+    }
+
+    suspend fun one(organisationId: String, operationTemplateId: String): OperationTemplate {
+        return fetchJsonApiResource("/v3/orgs/$organisationId/governance/operation-templates/$operationTemplateId")
+    }
+}
+
+val Api.operationTemplates: OperationTemplatesRouter
+    get() = OperationTemplatesRouter(httpClient)
+
+val OperationsRouter.templates: OperationTemplatesRouter
+    get() = OperationTemplatesRouter(httpClient)

src/main/kotlin/com/ctrlhub/core/governance/schemes/workorders/operations/templates/response/OperationTemplate.kt

@@ -0,0 +1,53 @@
+package com.ctrlhub.core.governance.schemes.workorders.operations.templates.response
+
+import com.ctrlhub.core.governance.response.Label
+import com.fasterxml.jackson.annotation.JsonCreator
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties
+import com.fasterxml.jackson.annotation.JsonProperty
+import com.github.jasminb.jsonapi.StringIdHandler
+import com.github.jasminb.jsonapi.annotations.Id
+import com.github.jasminb.jsonapi.annotations.Meta
+import com.github.jasminb.jsonapi.annotations.Type
+import java.time.LocalDateTime
+
+@JsonIgnoreProperties(ignoreUnknown = true)
+@Type("operation-templates")
+class OperationTemplate @JsonCreator constructor(
+    @Id(StringIdHandler::class) var id: String = "",
+    @JsonProperty("labels") var labels: List<Label> = emptyList(),
+    @JsonProperty("requirements") var requirements: OperationTemplateRequirements? = null,
+
+    @Meta
+    var meta: OperationTemplateMeta = OperationTemplateMeta()
+) {
+    constructor(): this(
+        id = "",
+        requirements = null
+    )
+}
+
+@JsonIgnoreProperties(ignoreUnknown = true)
+class OperationTemplateRequirements @JsonCreator constructor(
+    var forms: List<OperationFormResult> = emptyList()
+) {
+    constructor(): this(
+        forms = emptyList()
+    )
+}
+
+@JsonIgnoreProperties(ignoreUnknown = true)
+class OperationTemplateMeta @JsonCreator constructor(
+    @JsonProperty("created_at") var createdAt: LocalDateTime? = null,
+    @JsonProperty("updated_at") var updatedAt: LocalDateTime? = null
+)
+
+@JsonIgnoreProperties(ignoreUnknown = true)
+class OperationFormResult @JsonCreator constructor(
+    var id: String = "",
+    var required: Boolean = false
+) {
+    constructor(): this(
+        id = "",
+        required = false
+    )
+}

src/test/kotlin/com/ctrlhub/core/governance/schemes/workorders/operations/templates/OperationTemplatesRouterTest.kt

@@ -0,0 +1,67 @@
+package com.ctrlhub.core.governance.schemes.workorders.operations.templates
+
+import com.ctrlhub.core.configureForTest
+import com.ctrlhub.core.governance.schemes.workorders.operations.templates.response.OperationTemplate
+import io.ktor.client.*
+import io.ktor.client.engine.mock.*
+import io.ktor.http.*
+import kotlinx.coroutines.runBlocking
+import org.junit.jupiter.api.Test
+import java.nio.file.Files
+import java.nio.file.Paths
+import kotlin.test.assertIs
+import kotlin.test.assertNotNull
+
+class OperationTemplatesRouterTest {
+
+    @Test
+    fun `can retrieve all operation templates`() {
+        val jsonFilePath = Paths.get("src/test/resources/governance/schemes/workorders/operations/templates/all-operation-templates-response.json")
+        val jsonContent = Files.readString(jsonFilePath)
+
+        val mockEngine = MockEngine { _ ->
+            respond(
+                content = jsonContent,
+                status = HttpStatusCode.OK,
+                headers = headersOf(HttpHeaders.ContentType, "application/json")
+            )
+        }
+
+        val router = OperationTemplatesRouter(httpClient = HttpClient(mockEngine).configureForTest())
+
+        runBlocking {
+            val response = router.all(
+                organisationId = "org-123"
+            )
+
+            assertIs<List<OperationTemplate>>(response)
+            assertNotNull(response.first().id)
+        }
+    }
+
+    @Test
+    fun `can retrieve a single operation template`() {
+        val jsonFilePath = Paths.get("src/test/resources/governance/schemes/workorders/operations/templates/one-operation-template-response.json")
+        val jsonContent = Files.readString(jsonFilePath)
+
+        val mockEngine = MockEngine { _ ->
+            respond(
+                content = jsonContent,
+                status = HttpStatusCode.OK,
+                headers = headersOf(HttpHeaders.ContentType, "application/json")
+            )
+        }
+
+        val router = OperationTemplatesRouter(httpClient = HttpClient(mockEngine).configureForTest())
+
+        runBlocking {
+            val response = router.one(
+                organisationId = "org-123",
+                operationTemplateId = "template-456"
+            )
+
+            assertIs<OperationTemplate>(response)
+            assertNotNull(response.id)
+        }
+    }
+}

src/test/resources/governance/schemes/workorders/operations/templates/all-operation-templates-response.json

@@ -0,0 +1,66 @@
+{
+  "data": [
+    {
+      "id": "f3c6de1f-20f2-4c8a-9e0b-65e89d8df3a2",
+      "type": "operation-templates",
+      "attributes": {
+        "labels": [
+          {
+            "key": "a",
+            "value": "b"
+          }
+        ],
+        "name": "Test",
+        "requirements": null
+      },
+      "meta": {
+        "created_at": "2025-03-20T13:22:11Z",
+        "updated_at": "2025-03-20T13:22:11Z"
+      }
+    }
+  ],
+  "meta": {
+    "features": {
+      "params": {
+        "include": {
+          "options": null
+        },
+        "sort": {
+          "default": "name",
+          "options": [
+            "name",
+            "created_at"
+          ]
+        },
+        "filter": {
+          "options": null
+        }
+      }
+    },
+    "count": 1,
+    "pagination": {
+      "current_page": 1,
+      "counts": {
+        "resources": 1,
+        "pages": 1
+      },
+      "requested": {
+        "offset": 0,
+        "limit": 100
+      },
+      "offsets": {
+        "previous": null,
+        "next": null
+      }
+    }
+  },
+  "jsonapi": {
+    "version": "1.0",
+    "meta": {
+
+    }
+  },
+  "links": {
+    "self": "https://api.ctrl-hub.dev/v3/orgs/f3c6de1f-20f2-4c8a-9e0b-65e89d8df3a2/governance/operation-templates"
+  }
+}

src/test/resources/governance/schemes/workorders/operations/templates/one-operation-template-response.json

@@ -0,0 +1,28 @@
+{
+  "data": {
+    "id": "f3c6de1f-20f2-4c8a-9e0b-65e89d8df3a2",
+    "type": "operation-templates",
+    "attributes": {
+      "labels": [
+        {
+          "key": "a",
+          "value": "b"
+        }
+      ],
+      "name": "Test",
+      "requirements": null
+    },
+    "meta": {
+      "created_at": "2025-03-20T13:22:11Z",
+      "updated_at": "2025-03-20T13:22:11Z"
+    }
+  },
+  "meta": {},
+  "jsonapi": {
+    "version": "1.0",
+    "meta": {}
+  },
+  "links": {
+    "self": "https://api.ctrl-hub.dev/v3/orgs/f3c6de1f-20f2-4c8a-9e0b-65e89d8df3a2/governance/operation-templates/f3c6de1f-20f2-4c8a-9e0b-65e89d8df3a2"
+  }
+}