refactor: convert query's structs to enums for search

Author: GuillaumeDecMeetsMore

clients/javascript/lib/gen_types/DateTimeQuery.ts

@@ -3,27 +3,9 @@
 /**
  * Query parameters for searching on a date time
  */
-export type DateTimeQuery = {
-  /**
-   * Optional "equal" query (UTC)
-   */
-  eq?: Date
-  /**
-   * Optional "greater than or equal" query (UTC)
-   */
-  gte?: Date
-  /**
-   * Optional "less than or equal" query (UTC)
-   */
-  lte?: Date
-  /**
-   * Optional "greater than" query (UTC)
-   * This is exclusive of the value
-   */
-  gt?: Date
-  /**
-   * Optional "less than" query (UTC)
-   * This is exclusive of the value
-   */
-  lt?: Date
-}
+export type DateTimeQuery =
+  | { eq: Date }
+  | { gte: Date }
+  | { lte: Date }
+  | { gt: Date }
+  | { lt: Date }

clients/javascript/lib/gen_types/IDQuery.ts

@@ -4,25 +4,8 @@ import type { ID } from './ID'
 /**
  * Query parameters for searching on an ID (or list of IDs)
  */
-export type IDQuery = {
-  /**
-   * Optional ID (equality test)
-   */
-  eq?: ID
-  /**
-   * Optional ID (inequality test)
-   * If "eq" is provided, this field is ignored
-   */
-  ne?: ID
-  /**
-   * Optional bool (existence test)
-   * If "eq" is provided, this field is ignored
-   */
-  exists?: boolean
-  /**
-   * Optional list of IDs (equality test)
-   * If "eq" is provided, this field is ignored
-   * (use r# in the field name as "in" is a reserved keyword)
-   */
-  in?: Array<ID>
-}
+export type IDQuery =
+  | { eq: ID }
+  | { ne: ID }
+  | { exists: boolean }
+  | { in: Array<ID> }

clients/javascript/lib/gen_types/StringQuery.ts

@@ -3,25 +3,8 @@
 /**
  * Query parameters for searching on a string
  */
-export type StringQuery = {
-  /**
-   * Optional String (equality test)
-   */
-  eq?: string
-  /**
-   * Optional string (inequality test)
-   * If "eq" is provided, this field is ignored
-   */
-  ne?: string
-  /**
-   * Optional bool (existence test)
-   * If "eq" is provided, this field is ignored
-   */
-  exists?: boolean
-  /**
-   * Optional list of strings (equality test)
-   * If "eq" is provided, this field is ignored
-   * (use r# in the field name as "in" is a reserved keyword)
-   */
-  in?: Array<string>
-}
+export type StringQuery =
+  | { eq: string }
+  | { ne: string }
+  | { exists: boolean }
+  | { in: Array<string> }

crates/api/src/account/account_search_events.rs

@@ -1,6 +1,6 @@
 use actix_web::{web, HttpRequest, HttpResponse};
 use nittei_api_structs::{account_search_events::*, dtos::CalendarEventDTO};
-use nittei_domain::{DateTimeQuery, IdQuery, StringQuery, ID};
+use nittei_domain::{DateTimeQuery, IDQuery, StringQuery, ID};
 use nittei_infra::{NitteiContext, SearchEventsForAccountParams, SearchEventsParams};
 
 use crate::{
@@ -46,7 +46,7 @@ pub struct AccountSearchEventsUseCase {
     pub parent_id: Option<StringQuery>,
 
     /// Optional query on the group ID
-    pub group_id: Option<IdQuery>,
+    pub group_id: Option<IDQuery>,
 
     /// Optional query on start time - "lower than or equal", or "great than or equal" (UTC)
     pub start_time: Option<DateTimeQuery>,

crates/api/src/event/search_events.rs

@@ -1,6 +1,6 @@
 use actix_web::{web, HttpRequest, HttpResponse};
 use nittei_api_structs::{dtos::CalendarEventDTO, search_events::*};
-use nittei_domain::{DateTimeQuery, IdQuery, StringQuery, ID};
+use nittei_domain::{DateTimeQuery, IDQuery, StringQuery, ID};
 use nittei_infra::{NitteiContext, SearchEventsForUserParams, SearchEventsParams};
 
 use crate::{
@@ -55,7 +55,7 @@ pub struct SearchEventsUseCase {
     pub parent_id: Option<StringQuery>,
 
     /// Optional query on the group ID
-    pub group_id: Option<IdQuery>,
+    pub group_id: Option<IDQuery>,
 
     /// Optional query on start time - "lower than or equal", or "great than or equal" (UTC)
     pub start_time: Option<DateTimeQuery>,

crates/api_structs/src/account/api.rs

@@ -148,7 +148,7 @@ pub mod remove_account_integration {
 
 /// Request body for searching events for a whole account (across all users)
 pub mod account_search_events {
-    use nittei_domain::{DateTimeQuery, IdQuery, StringQuery};
+    use nittei_domain::{DateTimeQuery, IDQuery, StringQuery};
     use serde::{Deserialize, Serialize};
     use ts_rs::TS;
     use validator::Validate;
@@ -162,15 +162,15 @@ pub mod account_search_events {
     pub struct RequestBody {
         /// Optional query on user ID, or list of user IDs
         #[ts(optional)]
-        pub user_id: Option<IdQuery>,
+        pub user_id: Option<IDQuery>,
 
         /// Optional query on parent ID (which is a string as it's an ID from an external system)
         #[ts(optional)]
         pub parent_id: Option<StringQuery>,
 
         /// Optional query on the group ID
         #[ts(optional)]
-        pub group_id: Option<IdQuery>,
+        pub group_id: Option<IDQuery>,
 
         /// Optional query on start time - e.g. "lower than or equal", or "great than or equal" (UTC)
         #[ts(optional)]

crates/api_structs/src/event/api.rs

@@ -297,7 +297,7 @@ pub mod get_events_by_calendars {
 }
 
 pub mod search_events {
-    use nittei_domain::{DateTimeQuery, IdQuery, StringQuery};
+    use nittei_domain::{DateTimeQuery, IDQuery, StringQuery};
 
     use super::*;
 
@@ -321,7 +321,7 @@ pub mod search_events {
 
         /// Optional query on group ID
         #[ts(optional)]
-        pub group_id: Option<IdQuery>,
+        pub group_id: Option<IDQuery>,
 
         /// Optional query on start time - "lower than or equal", or "great than or equal" (UTC)
         #[ts(optional)]

crates/domain/src/lib.rs

@@ -40,7 +40,7 @@ pub use service::{
 pub use shared::{
     datetime_query::DateTimeQuery,
     entity::{Entity, ID},
-    id_query::IdQuery,
+    id_query::IDQuery,
     metadata::{Meta, Metadata},
     recurrence::{RRuleFrequency, RRuleOptions, WeekDayRecurrence},
     string_query::StringQuery,

crates/domain/src/shared/datetime_query.rs

@@ -1,32 +1,31 @@
 use chrono::{DateTime, Utc};
 use serde::{Deserialize, Serialize};
 use ts_rs::TS;
-use validator::Validate;
 
 /// Query parameters for searching on a date time
-#[derive(Deserialize, Serialize, TS, Debug, Validate, Clone)]
+#[derive(Deserialize, Serialize, TS, Debug, Clone)]
 #[serde(rename_all = "camelCase")]
 #[ts(export, rename = "DateTimeQuery")]
-pub struct DateTimeQuery {
-    /// Optional "equal" query (UTC)
-    #[ts(type = "Date", optional)]
-    pub eq: Option<DateTime<Utc>>,
+pub enum DateTimeQuery {
+    /// "equal" query (UTC)
+    #[ts(type = "Date")]
+    Eq(DateTime<Utc>),
 
-    /// Optional "greater than or equal" query (UTC)
-    #[ts(type = "Date", optional)]
-    pub gte: Option<DateTime<Utc>>,
+    /// "greater than or equal" query (UTC)
+    #[ts(type = "Date")]
+    Gte(DateTime<Utc>),
 
-    /// Optional "less than or equal" query (UTC)
-    #[ts(type = "Date", optional)]
-    pub lte: Option<DateTime<Utc>>,
+    /// "less than or equal" query (UTC)
+    #[ts(type = "Date")]
+    Lte(DateTime<Utc>),
 
-    /// Optional "greater than" query (UTC)
+    /// "greater than" query (UTC)
     /// This is exclusive of the value
-    #[ts(type = "Date", optional)]
-    pub gt: Option<DateTime<Utc>>,
+    #[ts(type = "Date")]
+    Gt(DateTime<Utc>),
 
-    /// Optional "less than" query (UTC)
+    /// "less than" query (UTC)
     /// This is exclusive of the value
-    #[ts(type = "Date", optional)]
-    pub lt: Option<DateTime<Utc>>,
+    #[ts(type = "Date")]
+    Lt(DateTime<Utc>),
 }

crates/domain/src/shared/id_query.rs

@@ -1,31 +1,22 @@
 use serde::{Deserialize, Serialize};
 use ts_rs::TS;
-use validator::Validate;
 
 use crate::ID;
 
 /// Query parameters for searching on an ID (or list of IDs)
-#[derive(Deserialize, Serialize, TS, Debug, Validate, Clone)]
+#[derive(Deserialize, Serialize, TS, Debug, Clone)]
 #[serde(rename_all = "camelCase")]
 #[ts(export, rename = "IDQuery")]
-pub struct IdQuery {
-    /// Optional ID (equality test)
-    #[ts(optional)]
-    pub eq: Option<ID>,
+pub enum IDQuery {
+    /// ID (equality test)
+    Eq(ID),
 
-    /// Optional ID (inequality test)
-    /// If "eq" is provided, this field is ignored
-    #[ts(optional)]
-    pub ne: Option<ID>,
+    /// ID (inequality test)
+    Ne(ID),
 
-    /// Optional bool (existence test)
-    /// If "eq" is provided, this field is ignored
-    #[ts(optional)]
-    pub exists: Option<bool>,
+    /// Bool (existence test)
+    Exists(bool),
 
-    /// Optional list of IDs (equality test)
-    /// If "eq" is provided, this field is ignored
-    /// (use r# in the field name as "in" is a reserved keyword)
-    #[ts(optional)]
-    pub r#in: Option<Vec<ID>>,
+    /// List of IDs (equality test)
+    In(Vec<ID>),
 }