refactor: remove events_groups - remove unique constraint - rename pa… (

#217) * refactor: remove events_groups - remove unique constraint - rename parent_id * fix: remove old types * chore: add a little more docs * chore: add more docs (2) * fix: generate TS types * chore: adapt docs on the JS side
meetsmore · Feb 19, 2025 · aa48405 · aa48405
1 parent b23f28f
commit aa48405
Show file tree

Hide file tree

Showing 75 changed files with 287 additions and 2,474 deletions.
diff --git a/bins/nittei/tests/api.rs b/bins/nittei/tests/api.rs
@@ -482,9 +482,8 @@ async fn test_crud_events() {
     let event = admin_client
         .event
         .create(CreateEventInput {
-            parent_id: None,
+            external_parent_id: None,
             external_id: None,
-            group_id: None,
             title: None,
             description: None,
             event_type: None,
@@ -533,12 +532,11 @@ async fn test_crud_events() {
             event_id: event.id.clone(),
             title: None,
             description: None,
-            group_id: None,
             event_type: None,
             location: None,
             status: None,
             all_day: None,
-            parent_id: None,
+            external_parent_id: None,
             external_id: None,
             busy: None,
             duration: None,
@@ -765,9 +763,8 @@ async fn test_freebusy_multiple() {
     let _event1 = admin_client
         .event
         .create(CreateEventInput {
-            parent_id: None,
+            external_parent_id: None,
             external_id: None,
-            group_id: None,
             title: None,
             description: None,
             event_type: None,
@@ -793,9 +790,8 @@ async fn test_freebusy_multiple() {
     let _event2 = admin_client
         .event
         .create(CreateEventInput {
-            parent_id: None,
+            external_parent_id: None,
             external_id: None,
-            group_id: None,
             title: None,
             description: None,
             event_type: None,

diff --git a/bins/nittei/tests/api_loadtests.rs b/bins/nittei/tests/api_loadtests.rs
@@ -95,9 +95,8 @@ async fn create_300_events_1_month(
             .create(CreateEventInput {
                 user_id: user_id.clone(),
                 calendar_id: calendar_id.clone(),
-                parent_id: None,
+                external_parent_id: None,
                 external_id: None,
-                group_id: None,
                 title: None,
                 description: None,
                 event_type: None,

diff --git a/bins/nittei/tests/api_recurring_events.rs b/bins/nittei/tests/api_recurring_events.rs
@@ -52,9 +52,8 @@ async fn test_create_event_validation() {
     let event = admin_client
         .event
         .create(CreateEventInput {
-            parent_id: None,
+            external_parent_id: None,
             external_id: None,
-            group_id: None,
             title: None,
             description: None,
             event_type: None,
@@ -117,9 +116,8 @@ async fn test_expand_daily_recurring_event() {
     let event = admin_client
         .event
         .create(CreateEventInput {
-            parent_id: None,
+            external_parent_id: None,
             external_id: None,
-            group_id: None,
             title: None,
             description: None,
             event_type: None,
@@ -214,9 +212,8 @@ async fn test_expand_weekly_recurring_event() {
     let event = admin_client
         .event
         .create(CreateEventInput {
-            parent_id: None,
+            external_parent_id: None,
             external_id: None,
-            group_id: None,
             title: None,
             description: None,
             event_type: None,
@@ -307,9 +304,8 @@ async fn test_expand_monthly_recurring_event() {
     let event = admin_client
         .event
         .create(CreateEventInput {
-            parent_id: None,
+            external_parent_id: None,
             external_id: None,
-            group_id: None,
             title: None,
             description: None,
             event_type: None,
@@ -395,9 +391,8 @@ async fn test_expand_recurring_event_and_remove_exceptions() {
     let event = admin_client
         .event
         .create(CreateEventInput {
-            parent_id: None,
+            external_parent_id: None,
             external_id: None,
-            group_id: None,
             title: None,
             description: None,
             event_type: None,
@@ -432,9 +427,8 @@ async fn test_expand_recurring_event_and_remove_exceptions() {
     let exception_changed = admin_client
         .event
         .create(CreateEventInput {
-            parent_id: None,
+            external_parent_id: None,
             external_id: None,
-            group_id: None,
             title: None,
             description: None,
             event_type: None,
@@ -462,9 +456,8 @@ async fn test_expand_recurring_event_and_remove_exceptions() {
     let exception_removed = admin_client
         .event
         .create(CreateEventInput {
-            parent_id: None,
+            external_parent_id: None,
             external_id: None,
-            group_id: None,
             title: None,
             description: None,
             event_type: None,

diff --git a/bins/nittei/tests/collective_team_scheduling.rs b/bins/nittei/tests/collective_team_scheduling.rs
@@ -168,9 +168,8 @@ async fn test_collective_team_scheduling() {
 
         for (host, calendar) in hosts_with_calendar {
             let service_event = CreateEventInput {
-                parent_id: None,
+                external_parent_id: None,
                 external_id: None,
-                group_id: None,
                 title: None,
                 description: None,
                 event_type: None,

diff --git a/bins/nittei/tests/group_team_scheduling.rs b/bins/nittei/tests/group_team_scheduling.rs
@@ -186,9 +186,8 @@ async fn test_group_team_scheduling() {
             assert!(booking_intend.create_event_for_hosts);
             for (host, calendar) in hosts_with_calendar {
                 let service_event = CreateEventInput {
-                    parent_id: None,
+                    external_parent_id: None,
                     external_id: None,
-                    group_id: None,
                     title: None,
                     description: None,
                     event_type: None,
@@ -524,9 +523,8 @@ async fn test_group_team_scheduling_increase_max_count() {
         );
         assert!(booking_intend.create_event_for_hosts);
         let service_event = CreateEventInput {
-            parent_id: None,
+            external_parent_id: None,
             external_id: None,
-            group_id: None,
             title: None,
             description: None,
             event_type: None,
@@ -959,9 +957,8 @@ async fn test_group_team_scheduling_decrease_max_count() {
         );
         assert!(booking_intend.create_event_for_hosts);
         let service_event = CreateEventInput {
-            parent_id: None,
+            external_parent_id: None,
             external_id: None,
-            group_id: None,
             title: None,
             description: None,
             event_type: None,
@@ -1176,9 +1173,8 @@ async fn test_combination_of_services() {
 
     // And then create service event which is not busy
     let service_event = CreateEventInput {
-        parent_id: None,
+        external_parent_id: None,
         external_id: None,
-        group_id: None,
         title: None,
         description: None,
         event_type: None,

diff --git a/bins/nittei/tests/round_robin_scheduling.rs b/bins/nittei/tests/round_robin_scheduling.rs
@@ -191,9 +191,8 @@ async fn test_round_robin_scheduling_simple_test() {
 
                 // Create service event
                 let service_event = CreateEventInput {
-                    parent_id: None,
+                    external_parent_id: None,
                     external_id: None,
-                    group_id: None,
                     title: None,
                     description: None,
                     event_type: None,
@@ -315,9 +314,8 @@ async fn test_round_robin_equal_distribution_scheduling() {
             for _ in 0..*upcoming_service_events {
                 // Create service event
                 let service_event = CreateEventInput {
-                    parent_id: None,
+                    external_parent_id: None,
                     external_id: None,
-                    group_id: None,
                     title: None,
                     description: None,
                     event_type: None,
@@ -380,9 +378,8 @@ async fn test_round_robin_equal_distribution_scheduling() {
                 .find(|(h, _)| h.id == booking_intend.selected_hosts[0].id)
                 .expect("To find selected host");
             let service_event = CreateEventInput {
-                parent_id: None,
+                external_parent_id: None,
                 external_id: None,
-                group_id: None,
                 title: None,
                 description: None,
                 event_type: None,
@@ -514,9 +511,8 @@ async fn test_round_robin_availability_scheduling() {
         {
             // Create service event
             let service_event = CreateEventInput {
-                parent_id: None,
+                external_parent_id: None,
                 external_id: None,
-                group_id: None,
                 title: None,
                 description: None,
                 event_type: None,
@@ -598,9 +594,8 @@ async fn test_round_robin_availability_scheduling() {
                 .expect("To find selected host");
 
             let service_event = CreateEventInput {
-                parent_id: None,
+                external_parent_id: None,
                 external_id: None,
-                group_id: None,
                 title: None,
                 description: None,
                 event_type: None,

diff --git a/clients/javascript/lib/eventClient.ts b/clients/javascript/lib/eventClient.ts
@@ -1,7 +1,6 @@
 import { NitteiBaseClient } from './baseClient'
 import type {
   GetEventsByExternalIdAPIResponse,
-  GetEventsByExternalIdQueryParams,
   SearchEventsAPIResponse,
   SearchEventsRequestBody,
 } from './gen_types'
@@ -78,19 +77,16 @@ export class NitteiEventClient extends NitteiBaseClient {
 
   /**
    * Get events by external id
-   * This returns an array of events
-   * It can be empty if no events are found
-   * @param externalId - external id of the event
-   * @param queryParams - query params (optional) - allow to specify that the events from groups should be included
+   *
+   * This returns an array of events (it can match zero, one or more events)
+   * @param externalId - external id of the event(s) to search
    * @returns - the events found
    */
   public async getByExternalId(
-    externalId: string,
-    queryParams?: GetEventsByExternalIdQueryParams
+    externalId: string
   ): Promise<GetEventsByExternalIdAPIResponse> {
     const res = await this.get<GetEventsByExternalIdAPIResponse>(
-      `/user/events/external_id/${externalId}`,
-      queryParams
+      `/user/events/external_id/${externalId}`
     )
 
     return {

diff --git a/clients/javascript/lib/eventGroupClient.ts b/clients/javascript/lib/eventGroupClient.ts
diff --git a/clients/javascript/lib/gen_types/CalendarEventDTO.ts b/clients/javascript/lib/gen_types/CalendarEventDTO.ts
@@ -40,10 +40,17 @@ export type CalendarEventDTO = {
   status: CalendarEventStatus
   /**
    * Optional parent event ID
+   * This is useful for external applications that need to link Nittei's events to a wider data model (e.g. a project, an order, etc.)
+   * Example: If the event is a meeting, the parent ID could be the project ID (ObjectId, UUID or any other string)
    */
-  parentId: string | null
+  externalParentId: string | null
   /**
    * Optional external ID
+   * This is useful for external applications that need to link Nittei's events to their own data models
+   * Example: If the event is a meeting, the external ID could be the meeting ID in the external system
+   *
+   * Note that nothing prevents multiple events from having the same external ID
+   * This can also be a way to link events together
    */
   externalId: string | null
   /**
@@ -98,10 +105,6 @@ export type CalendarEventDTO = {
    * UUID of the user
    */
   userId: ID
-  /**
-   * Optional group ID
-   */
-  groupId: ID | null
   /**
    * List of reminders
    */