@tellescope/schema 0.0.10 → 0.0.14

package/src/schema.ts

@@ -13,12 +13,16 @@ import {
   JSONType,
   CRUD,
   HTTPMethod,
+  SessionType,
+  UserIdentity,
 } from "@tellescope/types-utilities"
 import {
   EnduserSession,
-  ConfiguredSession,
+  ChatRoom,
   JourneyState,
   UserSession,
+  AttendeeInfo,
+  MeetingStatus,
 } from "@tellescope/types-models"
 
 import {
@@ -57,6 +61,13 @@ import {
   listOfDisplayNameInfo,
   fileTypeValidator,
   fileSizeValidator,
+  meetingStatusValidator,
+  listOfAttendeesValidator,
+  meetingInfoValidator,
+  listOfUserIndentitiesValidator,
+  attendeeInfoValidator,
+  listOfObjectAnyFieldsValidator,
+  meetingsListValidator,
 } from "@tellescope/validation"
 
 import {
@@ -246,12 +257,23 @@ export type CustomActions = {
       { isAuthenticated: true, enduser: Enduser } | { isAuthenticated: false, enduser: null }
     >,
     refresh_session: CustomAction<{}, { enduser: Enduser, authToken: string }>,
+    generate_auth_token: CustomAction<{ id: string }, { authToken: string }>,
     logout: CustomAction<{ }, { }>,
   },
   users: {
     display_names: CustomAction<{ }, { fname: string, lname: string, id: string }[]>,
     refresh_session: CustomAction<{}, { user: UserSession, authToken: string }>,
-  }
+  },
+  chat_rooms: {
+    join_room: CustomAction<{ id: string }, { room: ChatRoom }>,
+  },
+  meetings: {
+    start_meeting: CustomAction<{ }, { id: string, meeting: object, host: AttendeeInfo }>, 
+    end_meeting: CustomAction<{ id: string }, { }>, 
+    add_attendees_to_meeting: CustomAction<{ id: string, attendees: UserIdentity[] }, { }>, 
+    my_meetings: CustomAction<{}, { id: string, updatedAt: string, status: MeetingStatus }[]>
+    attendee_info: CustomAction<{ id: string }, { attendee: AttendeeInfo, others: UserIdentity[] }>,
+  },
 } 
 
 export type PublicActions = {
@@ -326,6 +348,9 @@ export const schema: SchemaV1 = {
       lname: { 
         validator: nameValidator,
       },
+      dateOfBirth: { 
+        validator: dateValidator,
+      },
       journeys: { 
         validator: journeysValidator,
         dependencies: [
@@ -413,6 +438,14 @@ export const schema: SchemaV1 = {
           enduser: { validator: 'enduser' }, 
         } as any // todo: add enduser eventually, when validator defined
       },
+      generate_auth_token: {
+        op: "custom", access: 'create', method: "get",
+        name: 'Generate authToken',
+        path: '/generate-enduser-auth-token',
+        description: "Generates an authToken for use by an enduser. Useful for integrating a 3rd-party authentication process or creating a session for an enduser without a set password in Tellescope.",
+        parameters: { id: { validator: mongoIdStringValidator } },
+        returns: { authToken: { validator: stringValidator100 } },
+      },
       logout: {
         op: "custom", access: 'update', method: "post",
         name: 'Logout enduser',
@@ -835,8 +868,8 @@ export const schema: SchemaV1 = {
       },
       userIds: {
         validator: listOfMongoIdStringValidator,
-        required: true,
         examples: [[PLACEHOLDER_ID]], 
+        // required: true, // no longer required
         // add pull dependency for user deletion?
       },
       enduserIds: {
@@ -852,11 +885,31 @@ export const schema: SchemaV1 = {
         validator: mongoIdStringValidator,
         initializer: () => '',
         readonly: true,
-      }
+      },
+      ticketId: {
+        validator: mongoIdStringValidator,
+      },
+      endedAt: {
+        validator: dateValidator,
+      },
+      tags: {
+        validator: listOfStringsValidator,
+      },
     },
     defaultActions: DEFAULT_OPERATIONS,
     enduserActions: { create: {}, read: {}, readMany: {} },
-    customActions: {},
+    customActions: {
+      join_room: {
+        op: "custom", access: 'update', method: "post",
+        name: 'Join chat room',
+        path: '/join-chat-room',
+        description: "Allows a user to join a chat room with no other users, for use in accepting support chats.",
+        parameters: { id: { validator: mongoIdStringValidator } },
+        returns: { 
+          room: { validator:  'Room' }, 
+        } as any // add room eventually, when validator defined
+      },
+    },
   },
   chats: {
     info: {
@@ -892,7 +945,7 @@ export const schema: SchemaV1 = {
       senderId: { 
         validator: mongoIdStringValidator,
         readonly: true, // create a separate endpoint for storing enduser chats
-        initializer: (a, s) => (s as UserSession).id ?? (s as EnduserSession).id,
+        initializer: (a, s) => s.id,
         examples: [PLACEHOLDER_ID],
         dependencies: [{ // can be userId or enduserId
           dependsOn: ['users', 'endusers'],
@@ -951,7 +1004,6 @@ export const schema: SchemaV1 = {
           enduser: { validator:  'user' }, 
         } as any // add enduser eventually, when validator defined
       },
-
     },
     enduserActions: { display_names: {} },
     fields: {
@@ -1129,9 +1181,11 @@ export const schema: SchemaV1 = {
         required: true,
         examples: [PLACEHOLDER_ID],
       },
-      closed: {
-        validator: booleanValidator,
-        initializer: () => false,
+      chatRoomId: {
+        validator: mongoIdStringValidator,
+      },
+      closedAt: {
+        validator: dateValidator,
       },
       owner: {
         validator: mongoIdStringValidator,
@@ -1148,4 +1202,92 @@ export const schema: SchemaV1 = {
       },
     }
   },
+  meetings: {
+    info: {},
+    constraints: {
+      unique: [], 
+      relationship: [],
+    },
+    defaultActions: { },
+    customActions: {
+      start_meeting: {
+        op: "custom", access: 'create', method: "post",
+        name: 'Start Meeting',
+        path: '/start-meeting',
+        description: "Generates an video meeting room",
+        parameters: { },
+        returns: { 
+          id: {
+            validator: mongoIdStringValidator,
+          },
+          meeting: {
+            validator: objectAnyFieldsValidator,
+          },
+          host: {
+            validator: attendeeInfoValidator,
+          },
+        },
+      },
+      end_meeting: { 
+        op: "custom", access: 'update', method: "post",
+        name: "End Meeting",
+        path: '/end-meeting',
+        description: "Ends a video meeting",
+        parameters: { id: { validator: mongoIdStringValidator } },
+        returns: { },
+      },
+      add_attendees_to_meeting: { 
+        op: "custom", access: 'update', method: "post",
+        name: 'Add Attendees to Meeting',
+        path: '/add-attendees-to-meeting',
+        description: "Adds other attendees to a meeting",
+        parameters: { 
+          id: { validator: mongoIdStringValidator },
+          attendees: { validator: listOfUserIndentitiesValidator },
+        },
+        returns: { },
+      },
+      attendee_info: {
+        op: "custom", access: 'read', method: "get",
+        name: 'Get attendee info for meeting',
+        path: '/attendee-info',
+        description: "Gets meeting info for the current user, and details about other attendees",
+        parameters: { 
+          id: { validator: mongoIdStringValidator },
+        },
+        returns: { 
+          attendee: { validator: attendeeInfoValidator },
+          others: { validator: listOfUserIndentitiesValidator },
+        },
+      },
+      my_meetings: {
+        op: "custom", access: 'read', method: "get",
+        name: 'Get list of meetings',
+        path: '/my-meetings',
+        description: "Gets meetings for the current user.",
+        parameters: { 
+          id: { validator: mongoIdStringValidator },
+        },
+        returns: { validator: meetingsListValidator },
+      }
+    },
+    enduserActions: { my_meetings: {} },
+    fields: {
+      ...BuiltInFields, 
+      // all fields are updatable by custom endpoints only
+      status: {
+        validator: meetingStatusValidator,
+        readonly: true,
+        initializer: () => 'scheduled',
+      },
+      attendees: {
+        validator: listOfAttendeesValidator,
+        readonly: true,
+      },
+      meetingInfo: {
+        validator: meetingInfoValidator,
+        readonly: true
+      }
+    }
+  },
 }