refactor(calendarEvents): rework search events + add search for account level (#183)

* feat(calendarEvent): add event_type field

* refactor(calendarEvents): rework search events + add account level for searching events

* fix: adapt JS + fix some issues in RS

* fix: StringQuery should be exported with that name

* test: add unit tests

* refactor: convert query's structs to enums for search

* fix: still allow multiple fields for dateTime

Author: GuillaumeDecMeetsMore

clients/javascript/lib/gen_types/AccountSearchEventsRequestBody.ts

@@ -0,0 +1,47 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { DateTimeQuery } from './DateTimeQuery'
+import type { IDQuery } from './IDQuery'
+import type { StringQuery } from './StringQuery'
+import type { JsonValue } from './serde_json/JsonValue'
+
+/**
+ * Request body for searching events for a whole account (across all users)
+ */
+export type AccountSearchEventsRequestBody = {
+  /**
+   * Optional query on user ID, or list of user IDs
+   */
+  userId?: IDQuery
+  /**
+   * Optional query on parent ID (which is a string as it's an ID from an external system)
+   */
+  parentId?: StringQuery
+  /**
+   * Optional query on the group ID
+   */
+  groupId?: IDQuery
+  /**
+   * Optional query on start time - e.g. "lower than or equal", or "great than or equal" (UTC)
+   */
+  startTime?: DateTimeQuery
+  /**
+   * Optional query on end time - e.g. "lower than or equal", or "great than or equal" (UTC)
+   */
+  endTime?: DateTimeQuery
+  /**
+   * Optional query on event type
+   */
+  eventType?: StringQuery
+  /**
+   * Optional query on event status
+   */
+  status?: StringQuery
+  /**
+   * Optional query on updated at - e.g. "lower than or equal", or "great than or equal" (UTC)
+   */
+  updatedAt?: DateTimeQuery
+  /**
+   * Optional query on metadata
+   */
+  metadata?: JsonValue
+}

clients/javascript/lib/gen_types/DateTimeQuery.ts

@@ -1,15 +1,7 @@
 // This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { DateTimeQueryRange } from './DateTimeQueryRange'
 
 /**
  * Query parameters for searching on a date time
  */
-export type DateTimeQuery = {
-  /**
-   * Optional "greater than or equal" query (UTC)
-   */
-  gte?: Date
-  /**
-   * Optional "less than or equal" query (UTC)
-   */
-  lte?: Date
-}
+export type DateTimeQuery = { eq: Date } | { range: DateTimeQueryRange }

clients/javascript/lib/gen_types/DateTimeQueryRange.ts

@@ -0,0 +1,22 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type DateTimeQueryRange = {
+  /**
+   * "greater than or equal" query (UTC)
+   */
+  gte?: Date
+  /**
+   * "less than or equal" query (UTC)
+   */
+  lte?: Date
+  /**
+   * "greater than" query (UTC)
+   * This is exclusive of the value
+   */
+  gt?: Date
+  /**
+   * "less than" query (UTC)
+   * This is exclusive of the value
+   */
+  lt?: Date
+}

clients/javascript/lib/gen_types/IDQuery.ts

@@ -1,17 +1,11 @@
 // This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { ID } from './ID'
 
 /**
- * Query parameters for searching on an ID
+ * Query parameters for searching on an ID (or list of IDs)
  */
-export type IDQuery = {
-  /**
-   * Optional String (equality test)
-   * This is not a UUID, but a string as we allow any type of ID in this field
-   */
-  eq?: string
-  /**
-   * Optional bool (existence test)
-   * If "eq" is provided, this field is ignored
-   */
-  exists?: boolean
-}
+export type IDQuery =
+  | { eq: ID }
+  | { ne: ID }
+  | { exists: boolean }
+  | { in: Array<ID> }

clients/javascript/lib/gen_types/SearchEventsRequestBody.ts

@@ -2,6 +2,7 @@
 import type { DateTimeQuery } from './DateTimeQuery'
 import type { ID } from './ID'
 import type { IDQuery } from './IDQuery'
+import type { StringQuery } from './StringQuery'
 import type { JsonValue } from './serde_json/JsonValue'
 
 /**
@@ -18,13 +19,13 @@ export type SearchEventsRequestBody = {
    */
   calendarIds?: Array<ID>
   /**
-   * Optional query on parent ID
+   * Optional query on parent ID (which is a string as it's an ID from an external system)
    */
-  parentId?: IDQuery
+  parentId?: StringQuery
   /**
    * Optional query on group ID
    */
-  groupId?: ID
+  groupId?: IDQuery
   /**
    * Optional query on start time - "lower than or equal", or "great than or equal" (UTC)
    */
@@ -34,9 +35,13 @@ export type SearchEventsRequestBody = {
    */
   endTime?: DateTimeQuery
   /**
-   * Optional list of event status
+   * Optional query on event type
    */
-  status?: Array<string>
+  eventType?: StringQuery
+  /**
+   * Optional query on status
+   */
+  status?: StringQuery
   /**
    * Optioanl query on updated at - "lower than or equal", or "great than or equal" (UTC)
    */

clients/javascript/lib/gen_types/StringQuery.ts

@@ -0,0 +1,10 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Query parameters for searching on a string
+ */
+export type StringQuery =
+  | { eq: string }
+  | { ne: string }
+  | { exists: boolean }
+  | { in: Array<string> }

clients/javascript/lib/gen_types/index.ts

@@ -2,6 +2,7 @@ export * from './AccountDTO'
 export * from './AccountEventRemindersDTO'
 export * from './AccountRemindersDTO'
 export * from './AccountResponse'
+export * from './AccountSearchEventsRequestBody'
 export * from './AccountSettingsDTO'
 export * from './AccountWebhookSettingsDTO'
 export * from './AddAccountIntegrationRequestBody'
@@ -28,6 +29,7 @@ export * from './CreateServiceEventIntendRequestBody'
 export * from './CreateServiceRequestBody'
 export * from './CreateUserRequestBody'
 export * from './DateTimeQuery'
+export * from './DateTimeQueryRange'
 export * from './EventGroup'
 export * from './EventGroupDTO'
 export * from './EventGroupResponse'
@@ -88,6 +90,7 @@ export * from './ServiceWithUsersDTO'
 export * from './ServiceWithUsersResponse'
 export * from './SetAccountPubKeyRequestBody'
 export * from './SetAccountWebhookRequestBody'
+export * from './StringQuery'
 export * from './Time'
 export * from './TimePlan'
 export * from './TimeSpan'

clients/javascript/tests/calendarEvent.spec.ts

@@ -522,7 +522,10 @@ describe('CalendarEvent API', () => {
         const res = await adminClient.events.searchEvents({
           userId: userId,
           startTime: {
-            gte: new Date(500),
+            range: {
+              lte: new Date(2000),
+              gte: new Date(500),
+            },
           },
         })
         expect(res.events.length).toBe(3)
@@ -532,7 +535,9 @@ describe('CalendarEvent API', () => {
         const res = await adminClient.events.searchEvents({
           userId: userId,
           startTime: {
-            gte: new Date(2000),
+            range: {
+              gte: new Date(2000),
+            },
           },
         })
         expect(res.events.length).toBe(0)
@@ -542,7 +547,9 @@ describe('CalendarEvent API', () => {
         const res = await adminClient.events.searchEvents({
           userId: userId,
           endTime: {
-            lte: new Date(2000),
+            range: {
+              lte: new Date(2000),
+            },
           },
         })
         expect(res.events.length).toBe(3)
@@ -552,7 +559,9 @@ describe('CalendarEvent API', () => {
         const res = await adminClient.events.searchEvents({
           userId: userId,
           endTime: {
-            lte: new Date(500),
+            range: {
+              lte: new Date(500),
+            },
           },
         })
         expect(res.events.length).toBe(0)
@@ -561,15 +570,19 @@ describe('CalendarEvent API', () => {
       it('should be able to search for events (status)', async () => {
         const res = await adminClient.events.searchEvents({
           userId: userId,
-          status: ['tentative'],
+          status: {
+            in: ['tentative'],
+          },
         })
         expect(res.events.length).toBe(2)
       })
 
       it('should be able to search for events (multiple status)', async () => {
         const res = await adminClient.events.searchEvents({
           userId: userId,
-          status: ['confirmed', 'tentative'],
+          status: {
+            in: ['confirmed', 'tentative'],
+          },
         })
         expect(res.events.length).toBe(3)
       })
@@ -603,7 +616,9 @@ describe('CalendarEvent API', () => {
             eq: 'parentId',
           },
           startTime: {
-            gte: new Date(500),
+            range: {
+              gte: new Date(500),
+            },
           },
         })
         expect(res.events.length).toBe(1)
@@ -617,7 +632,9 @@ describe('CalendarEvent API', () => {
             eq: 'parentId',
           },
           startTime: {
-            gte: new Date(2000),
+            range: {
+              gte: new Date(2000),
+            },
           },
         })
         expect(res.events.length).toBe(0)
@@ -627,7 +644,9 @@ describe('CalendarEvent API', () => {
         const res = await adminClient.events.searchEvents({
           userId: userId,
           updatedAt: {
-            gte: new Date(0),
+            range: {
+              gte: new Date(0),
+            },
           },
         })
         expect(res.events.length).toBe(3)
@@ -637,7 +656,9 @@ describe('CalendarEvent API', () => {
         const res = await adminClient.events.searchEvents({
           userId: userId,
           updatedAt: {
-            gte: new Date(new Date().getTime() + 10000),
+            range: {
+              gte: new Date(new Date().getTime() + 10000),
+            },
           },
         })
         expect(res.events.length).toBe(0)
@@ -683,7 +704,9 @@ describe('CalendarEvent API', () => {
 
         const resSearch = await adminClient.events.searchEvents({
           userId,
-          groupId: group.eventGroup.id,
+          groupId: {
+            eq: group.eventGroup.id,
+          },
         })
 
         expect(resSearch.events.length).toBe(1)