Feature/api response contract

backend/README.md

@@ -57,6 +57,26 @@ for example `dev.cleat.domain` and `dev.cleat.githubclient`.
 ./gradlew build                    # build and test everything
 ```
 
+Local dependencies (Postgres, Redis) are expected to run via Docker Compose. The
+two services build into one container image each.
+
+
+## Frontend–Backend Data Contract
+
+The following rules apply to data exchange between the Frontend (`apps/web/src/data/types.ts`) and the 
+Backend:
+
+1. Field Mapping: All fields in Backend DTOs (e.g., `repoCount`, `postureScore`) follow the same camelCase
+   naming convention as the Frontend interfaces.
+
+2. Enum Synchronization: Enums such as `AccountType`, `Plan`, and `Severity` are serialized using 
+   `@JsonValue` to the lowercase values expected by the Frontend (e.g., `user`, `critical`).
+
+3. ISO Dates: Date fields (e.g., `lastPushedAt`, `detectedAt`) use the `OffsetDateTime` type and are 
+   serialized to JSON as ISO-8601 formatted strings.
+
+4. Data Container: The Frontend `Dataset` type is backed by `DatasetDto`. To switch from mock data 
+   to real data, requests should be sent to the `/api/dashboard/dataset` endpoint.
 Local dependencies (Postgres, Redis) are expected to run via Docker Compose, while the API and Worker services are intended to be run locally via Gradle
 
 

backend/apps/api/src/main/java/dev/cleat/api/CleatApiApplication.java

@@ -1,11 +1,11 @@
-package dev.cleat.api;
-
-import org.springframework.boot.SpringApplication;
-import org.springframework.boot.autoconfigure.SpringBootApplication;
-
-@SpringBootApplication
-public class CleatApiApplication {
-    public static void main(String[] args) {
-        SpringApplication.run(CleatApiApplication.class);
-    }
-}
+package dev.cleat.api;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication(scanBasePackages = "dev.cleat")
+public class CleatApiApplication {
+    public static void main(String[] args) {
+        SpringApplication.run(CleatApiApplication.class);
+    }
+}

backend/apps/api/src/main/java/dev/cleat/api/controller/DashboardController.java

@@ -0,0 +1,25 @@
+package dev.cleat.api.controller;
+
+import dev.cleat.common.dto.response.DatasetDto;
+import dev.cleat.persistence.DashboardService;
+import java.util.UUID;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestHeader;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/api/dashboard")
+public class DashboardController {
+    private final DashboardService dashboardService;
+
+    public DashboardController(DashboardService dashboardService) {
+        this.dashboardService = dashboardService;
+    }
+
+    @GetMapping("/dataset")
+    public ResponseEntity<DatasetDto> getDashboardData(@RequestHeader("X-Account-Id") UUID accountId) {
+        return ResponseEntity.ok(dashboardService.getDataset(accountId));
+    }
+}

backend/apps/api/src/test/java/dev/cleat/api/AbstractIntegrationTest.java

@@ -1,21 +1,21 @@
-package dev.cleat.api;
-
-import org.springframework.boot.test.context.SpringBootTest;
-import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
-import org.testcontainers.containers.GenericContainer;
-import org.testcontainers.containers.PostgreSQLContainer;
-import org.testcontainers.junit.jupiter.Container;
-import org.testcontainers.junit.jupiter.Testcontainers;
-
-@Testcontainers
-@SpringBootTest
-public abstract class AbstractIntegrationTest {
-
-    @Container
-    @ServiceConnection
-    static PostgreSQLContainer<?> postgres = new PostgreSQLContainer<>("postgres:16-alpine");
-
-    @Container
-    @ServiceConnection
-    static GenericContainer<?> redis = new GenericContainer<>("redis:7-alpine").withExposedPorts(6379);
-}
+package dev.cleat.api;
+
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
+import org.testcontainers.containers.GenericContainer;
+import org.testcontainers.containers.PostgreSQLContainer;
+import org.testcontainers.junit.jupiter.Container;
+import org.testcontainers.junit.jupiter.Testcontainers;
+
+@Testcontainers
+@SpringBootTest
+public abstract class AbstractIntegrationTest {
+
+    @Container
+    @ServiceConnection
+    static PostgreSQLContainer<?> postgres = new PostgreSQLContainer<>("postgres:16-alpine");
+
+    @Container
+    @ServiceConnection
+    static GenericContainer<?> redis = new GenericContainer<>("redis:7-alpine").withExposedPorts(6379);
+}

backend/apps/api/src/test/java/dev/cleat/api/CleatApiTests.java

@@ -1,11 +1,11 @@
-package dev.cleat.api;
-
-import org.junit.jupiter.api.Test;
-import org.springframework.boot.test.context.SpringBootTest;
-
-@SpringBootTest
-public class CleatApiTests extends AbstractIntegrationTest {
-
-    @Test
-    void contextLoad() {}
-}
+package dev.cleat.api;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.boot.test.context.SpringBootTest;
+
+@SpringBootTest
+public class CleatApiTests extends AbstractIntegrationTest {
+
+    @Test
+    void contextLoad() {}
+}

backend/apps/worker/src/main/java/dev/cleat/worker/CleatWorkerApplication.java

@@ -1,14 +1,14 @@
-package dev.cleat.worker;
-
-import org.springframework.boot.SpringApplication;
-import org.springframework.boot.autoconfigure.SpringBootApplication;
-import org.springframework.scheduling.annotation.EnableScheduling;
-
-@SpringBootApplication
-@EnableScheduling
-public class CleatWorkerApplication {
-
-    public static void main(String[] args) {
-        SpringApplication.run(CleatWorkerApplication.class, args);
-    }
-}
+package dev.cleat.worker;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.scheduling.annotation.EnableScheduling;
+
+@SpringBootApplication
+@EnableScheduling
+public class CleatWorkerApplication {
+
+    public static void main(String[] args) {
+        SpringApplication.run(CleatWorkerApplication.class, args);
+    }
+}

backend/apps/worker/src/test/java/dev/cleat/worker/AbstractIntegrationTest.java

@@ -1,21 +1,21 @@
-package dev.cleat.worker;
-
-import org.springframework.boot.test.context.SpringBootTest;
-import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
-import org.testcontainers.containers.GenericContainer;
-import org.testcontainers.containers.PostgreSQLContainer;
-import org.testcontainers.junit.jupiter.Container;
-import org.testcontainers.junit.jupiter.Testcontainers;
-
-@Testcontainers
-@SpringBootTest
-public abstract class AbstractIntegrationTest {
-
-    @Container
-    @ServiceConnection
-    static PostgreSQLContainer<?> postgres = new PostgreSQLContainer<>("postgres:16-alpine");
-
-    @Container
-    @ServiceConnection
-    static GenericContainer<?> redis = new GenericContainer<>("redis:7-alpine").withExposedPorts(6379);
-}
+package dev.cleat.worker;
+
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
+import org.testcontainers.containers.GenericContainer;
+import org.testcontainers.containers.PostgreSQLContainer;
+import org.testcontainers.junit.jupiter.Container;
+import org.testcontainers.junit.jupiter.Testcontainers;
+
+@Testcontainers
+@SpringBootTest
+public abstract class AbstractIntegrationTest {
+
+    @Container
+    @ServiceConnection
+    static PostgreSQLContainer<?> postgres = new PostgreSQLContainer<>("postgres:16-alpine");
+
+    @Container
+    @ServiceConnection
+    static GenericContainer<?> redis = new GenericContainer<>("redis:7-alpine").withExposedPorts(6379);
+}

backend/apps/worker/src/test/java/dev/cleat/worker/CleatWorkerApplicationTests.java

@@ -1,11 +1,11 @@
-package dev.cleat.worker;
-
-import org.junit.jupiter.api.Test;
-import org.springframework.boot.test.context.SpringBootTest;
-
-@SpringBootTest
-public class CleatWorkerApplicationTests extends AbstractIntegrationTest {
-
-    @Test
-    void contextLoads() {}
-}
+package dev.cleat.worker;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.boot.test.context.SpringBootTest;
+
+@SpringBootTest
+public class CleatWorkerApplicationTests extends AbstractIntegrationTest {
+
+    @Test
+    void contextLoads() {}
+}

backend/libs/common/build.gradle.kts

@@ -5,6 +5,5 @@ plugins {
 dependencies {
     api("org.springframework.boot:spring-boot-starter")
     api("org.springframework.boot:spring-boot-starter-validation")
-
     testImplementation("org.springframework.boot:spring-boot-starter-test")
 }

backend/libs/common/src/main/java/dev/cleat/common/dto/BreakdownItem.java

@@ -0,0 +1,39 @@
+package dev.cleat.common.dto;
+
+import jakarta.persistence.Embeddable;
+import java.math.BigDecimal;
+
+@Embeddable
+public class BreakdownItem {
+
+    private String label;
+    private BigDecimal cost;
+    private String hex;
+
+    public String getLabel() {
+        return label;
+    }
+
+    public BreakdownItem setLabel(String label) {
+        this.label = label;
+        return this;
+    }
+
+    public BigDecimal getCost() {
+        return cost;
+    }
+
+    public BreakdownItem setCost(BigDecimal cost) {
+        this.cost = cost;
+        return this;
+    }
+
+    public String getHex() {
+        return hex;
+    }
+
+    public BreakdownItem setHex(String hex) {
+        this.hex = hex;
+        return this;
+    }
+}

backend/libs/common/src/main/java/dev/cleat/common/dto/UsagePointDto.java

@@ -0,0 +1,47 @@
+package dev.cleat.common.dto;
+
+import java.math.BigDecimal;
+
+public class UsagePointDto {
+
+    private String label;
+    private Integer minutes;
+    private Double storageGb;
+    private BigDecimal cost;
+
+    public String getLabel() {
+        return label;
+    }
+
+    public UsagePointDto setLabel(String label) {
+        this.label = label;
+        return this;
+    }
+
+    public Integer getMinutes() {
+        return minutes;
+    }
+
+    public UsagePointDto setMinutes(Integer minutes) {
+        this.minutes = minutes;
+        return this;
+    }
+
+    public Double getStorageGb() {
+        return storageGb;
+    }
+
+    public UsagePointDto setStorageGb(Double storageGb) {
+        this.storageGb = storageGb;
+        return this;
+    }
+
+    public BigDecimal getCost() {
+        return cost;
+    }
+
+    public UsagePointDto setCost(BigDecimal cost) {
+        this.cost = cost;
+        return this;
+    }
+}

backend/libs/common/src/main/java/dev/cleat/common/dto/request/AccountRequestDto.java

@@ -0,0 +1,48 @@
+package dev.cleat.common.dto.request;
+
+import dev.cleat.common.enums.AccountType;
+import dev.cleat.common.enums.Plan;
+
+public class AccountRequestDto {
+
+    private String login;
+    private String name;
+    private AccountType type;
+    private Plan plan;
+
+    public String getLogin() {
+        return login;
+    }
+
+    public AccountRequestDto setLogin(String login) {
+        this.login = login;
+        return this;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public AccountRequestDto setName(String name) {
+        this.name = name;
+        return this;
+    }
+
+    public AccountType getType() {
+        return type;
+    }
+
+    public AccountRequestDto setType(AccountType type) {
+        this.type = type;
+        return this;
+    }
+
+    public Plan getPlan() {
+        return plan;
+    }
+
+    public AccountRequestDto setPlan(Plan plan) {
+        this.plan = plan;
+        return this;
+    }
+}