feat: Add Project Usage types for User Visualisation (#2031)

* feat: Add Project Usage types for User Visualisation

* fix: Add typeshare types for project usage

* fix: Remove billable cycle

* feat: Create UserUsageResponse

Author: fussybeaver

common/src/models/project.rs

@@ -115,3 +115,39 @@ pub enum ComputeTier {
     #[strum(default, to_string = "Unknown: {0}")]
     Unknown(String),
 }
+
+/// Sub-Response for the /user/me/usage backend endpoint
+#[derive(Debug, Default, Deserialize, Serialize, Clone)]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
+#[typeshare::typeshare]
+pub struct ProjectUsageResponse {
+    /// Show the build minutes clocked against this Project.
+    pub build_minutes: ProjectUsageBuild,
+
+    /// Show the VCPU used by this project on the container platform.
+    pub vcpu: ProjectUsageVCPU,
+}
+
+/// Build Minutes subquery for the [`ProjectUsageResponse`] struct
+#[derive(Debug, Default, Deserialize, Serialize, Clone)]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
+#[typeshare::typeshare]
+pub struct ProjectUsageBuild {
+    /// Number of build minutes used by this project.
+    pub used: u32,
+
+    /// Limit of build minutes for this project, before additional charges are liable.
+    pub limit: u32,
+}
+
+/// VCPU subquery for the [`ProjectUsageResponse`] struct
+#[derive(Debug, Default, Deserialize, Serialize, Clone)]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
+#[typeshare::typeshare]
+pub struct ProjectUsageVCPU {
+    /// The VCPU reserved for this project
+    pub reserved: f32,
+
+    /// Cost accrued from VCPU usage for this project
+    pub billable_hours: f32,
+}

common/src/models/user.rs

@@ -1,12 +1,15 @@
+use std::collections::HashMap;
 #[cfg(feature = "display")]
 use std::fmt::Write;
 
-use chrono::{DateTime, Utc};
+use chrono::{DateTime, NaiveDate, Utc};
 #[cfg(feature = "display")]
 use crossterm::style::Stylize;
 use serde::{Deserialize, Serialize};
 use strum::{EnumString, IntoStaticStr};
 
+use super::project::ProjectUsageResponse;
+
 #[derive(Debug, Deserialize, Serialize)]
 #[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
 #[typeshare::typeshare]
@@ -220,3 +223,21 @@ pub struct CreateAccountRequest {
 pub struct UpdateAccountTierRequest {
     pub account_tier: AccountTier,
 }
+
+/// Response for the /user/me/usage backend endpoint
+#[derive(Debug, Default, Deserialize, Serialize, Clone)]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
+#[typeshare::typeshare]
+pub struct UserUsageResponse {
+    /// Billing cycle start, or monthly from user creation
+    /// depending on the account tier
+    pub start: NaiveDate,
+
+    /// Billing cycle end, or end of month from user creation
+    /// depending on the account tier
+    pub end: NaiveDate,
+
+    /// HashMap of project related metrics for this cycle
+    /// keyed by project_id
+    pub projects: HashMap<String, ProjectUsageResponse>,
+}