@tellescope/schema 0.0.9 → 0.0.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tellescope/schema",
-  "version": "0.0.9",
+  "version": "0.0.13",
   "description": "Schema definition for Tellescope models",
   "main": "./lib/cjs/schema.js",
   "module": "./lib/esm/schema.js",
@@ -23,11 +23,11 @@
   },
   "homepage": "https://github.com/tellescope-os/tellescope#readme",
   "dependencies": {
-    "@tellescope/constants": "^0.0.9",
-    "@tellescope/types-models": "^0.0.9",
-    "@tellescope/types-server": "^0.0.9",
-    "@tellescope/types-utilities": "^0.0.9",
-    "@tellescope/validation": "^0.0.9",
+    "@tellescope/constants": "^0.0.13",
+    "@tellescope/types-models": "^0.0.13",
+    "@tellescope/types-server": "^0.0.13",
+    "@tellescope/types-utilities": "^0.0.13",
+    "@tellescope/validation": "^0.0.13",
     "validator": "^13.1.17"
   },
   "devDependencies": {
@@ -42,5 +42,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "267964c111ed9747bcb81c720b8d6c393e196089"
+  "gitHead": "1eb38568bd39b941e6b4a2bad9e3b33841c26b39"
 }

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,16 +61,24 @@ import {
   listOfDisplayNameInfo,
   fileTypeValidator,
   fileSizeValidator,
+  meetingStatusValidator,
+  listOfAttendeesValidator,
+  meetingInfoValidator,
+  listOfUserIndentitiesValidator,
+  attendeeInfoValidator,
+  listOfObjectAnyFieldsValidator,
+  meetingsListValidator,
 } from "@tellescope/validation"
 
 import {
   CREATOR_ONLY_ACCESS,
   DEFAULT_OPERATIONS,
   PLACEHOLDER_ID,
+  ENDUSER_SESSION_TYPE,
 } from "@tellescope/constants"
 export type RelationshipConstraint<T> = {
   explanation: string; // human readable, for documentation purposes
-  evaluate: (v: T, dependencies: Indexable<Partial<DatabaseModel>>) => string | void;
+  evaluate: (v: T, dependencies: Indexable<Partial<DatabaseModel>>, session: UserSession | EnduserSession) => string | void;
 }
 
 export type DependencyAccessConstraint <T> = { type: 'dependency', foreignModel: ModelName, foreignField: string, accessField: keyof T  }
@@ -84,7 +96,7 @@ export type Constraint <T> = {
   access?: AccessConstraint<T>[];
 }
 
-export type Initializer <T, R> = (a: T, s: ConfiguredSession | EnduserSession) => R
+export type Initializer <T, R> = (a: T, s: UserSession | EnduserSession) => R
 
 export type EndpointOptions = {
   // parameters used for endpoint that aren't stored in the model
@@ -156,7 +168,7 @@ type ReadFilter <T> = { [K in keyof T]?: { required: boolean } }
 
 // m is the original model (or undefined, if create)
 // allows for easier event handling based on specific updates (by comparing args to pre-update model)
-export type SideEffectHandler <T, O=any> = (args: Partial<T>[], m: (Partial<T> | undefined)[] | undefined, n: (Partial<T> & { _id: ObjectId })[], s: ConfiguredSession | EnduserSession, o: O) => Promise<ErrorInfo[]>;
+export type SideEffectHandler <T, O=any> = (args: Partial<T>[], m: (Partial<T> | undefined)[] | undefined, n: (Partial<T> & { _id: ObjectId })[], s: UserSession | EnduserSession, o: O) => Promise<ErrorInfo[]>;
 
 type SideEffect = {
   name: string;
@@ -245,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 = {
@@ -325,6 +348,9 @@ export const schema: SchemaV1 = {
       lname: { 
         validator: nameValidator,
       },
+      dateOfBirth: { 
+        validator: dateValidator,
+      },
       journeys: { 
         validator: journeysValidator,
         dependencies: [
@@ -412,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',
@@ -810,7 +844,7 @@ export const schema: SchemaV1 = {
   chat_rooms: {
     info: {},
     constraints: { 
-      unique: [{ array: 'userIds' }], 
+      unique: [{ array: 'userIds' }, { array: 'enduserIds' }], 
       relationship: [],
       access: [
         { type: 'filter', field: 'userIds' }, 
@@ -834,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: {
@@ -851,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: {
@@ -891,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'],
@@ -950,7 +1004,6 @@ export const schema: SchemaV1 = {
           enduser: { validator:  'user' }, 
         } as any // add enduser eventually, when validator defined
       },
-
     },
     enduserActions: { display_names: {} },
     fields: {
@@ -985,6 +1038,9 @@ export const schema: SchemaV1 = {
       roles: {
         validator: listOfStringsValidator,
       },
+      skills: {
+        validator: listOfStringsValidator,
+      },
       avatar: {
         validator: stringValidator100,
         dependencies: [
@@ -1095,5 +1151,143 @@ export const schema: SchemaV1 = {
         },
       },
     },
-  }
+  },
+  tickets: {
+    info: {},
+    constraints: {
+      unique: [], 
+      relationship: [
+        {
+          explanation: 'When created by an enduser, enduserId must match their id',
+          evaluate: ({ enduserId },_,session) => {
+          if (session.type === ENDUSER_SESSION_TYPE && session.id !== enduserId)
+            return "enduserId does not match creator id for enduser session"
+          } 
+        },
+      ],
+    },
+    defaultActions: DEFAULT_OPERATIONS,
+    customActions: {},
+    enduserActions: { create: {}, read: {}, readMany: {} },
+    fields: {
+      ...BuiltInFields, 
+      title: {
+        validator: stringValidator100,
+        required: true,
+        examples: ["Ticket Name"],
+      },
+      enduserId: {
+        validator: mongoIdStringValidator,
+        required: true,
+        examples: [PLACEHOLDER_ID],
+      },
+      chatRoomId: {
+        validator: mongoIdStringValidator,
+      },
+      closedAt: {
+        validator: dateValidator,
+      },
+      owner: {
+        validator: mongoIdStringValidator,
+      },
+      message: {
+        validator: stringValidator5000,
+        examples: ["Message"],
+      },
+      type: {
+        validator: stringValidator100,
+      },
+      skillsRequired: {
+        validator: listOfStringsValidator,
+      },
+    }
+  },
+  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
+      }
+    }
+  },
 }