@tellescope/schema 1.2.5 → 1.3.3

package/src/schema.ts

@@ -4,6 +4,7 @@ import {
   DatabaseRecord,
   ObjectId,
   ModelName,
+  User,
 } from "@tellescope/types-server"
 import {
   ErrorInfo,
@@ -37,6 +38,9 @@ import {
   Enduser,
   Journey,
   FormResponse,
+  FormField,
+  Form,
+  Meeting,
 } from "@tellescope/types-client"
 
 import {
@@ -106,6 +110,9 @@ import {
   previousFormFieldsValidator,
   numberValidator,
   organizationThemeValidator,
+  managedContentRecordTypeValidator,
+  passwordValidator,
+  flowchartUIValidator,
 } from "@tellescope/validation"
 
 import {
@@ -313,6 +320,11 @@ export type CustomActions = {
   form_responses: {
     prepare_form_response: CustomAction<{ formId: string, enduserId: string, automationStepId?: string }, { accessCode: string, url: string }>,
     submit_form_response: CustomAction<{ accessCode: string, responses: FormResponseValue[], automationStepId?: string  }, { formResponse: FormResponse }>,
+    info_for_access_code: CustomAction<{ accessCode: string }, {
+      form: Form, 
+      fields: FormField[], 
+      response: FormResponse, 
+    }>,
   },
   journeys: {
     update_state: CustomAction<{ updates: Partial<JourneyState>, id: string, name: string }, { updated: Journey }>,
@@ -332,10 +344,16 @@ export type CustomActions = {
   users: {
     display_info: CustomAction<{ }, { fname: string, lname: string, id: string }[]>,
     refresh_session: CustomAction<{}, { user: UserSession, authToken: string }>,
+    generate_auth_token: CustomAction<{ id?: string, phone?: string, email?: string, externalId?: string, durationInSeconds?: number }, { 
+      authToken: string, 
+      enduser?: Enduser,
+      user?: User,
+    }>,
   },
   chat_rooms: {
     join_room: CustomAction<{ id: string }, { room: ChatRoom }>,
     display_info: CustomAction<{ id: string }, { id: string, display_info: { [index: string]: UserDisplayInfo } }>,
+    mark_read: CustomAction<{ id: string }, { updated: ChatRoom }>,
   },
   meetings: {
     start_meeting: CustomAction<{ attendees?: UserIdentity[], publicRead?: boolean }, { id: string, meeting: { Meeting: MeetingInfo }, host: Attendee }>, 
@@ -344,8 +362,9 @@ export type CustomActions = {
     add_attendees_to_meeting: CustomAction<{ id: string, attendees: UserIdentity[] }, { }>, 
     my_meetings: CustomAction<{}, { id: string, updatedAt: string, status: MeetingStatus }[]>
     attendee_info: CustomAction<{ id: string }, { attendee: Attendee, others: UserIdentity[] }>,
-    start_meeting_for_event: CustomAction<{ calendarEventId: string }, { meeting: { Meeting: MeetingInfo }, host: Attendee }>, 
+    start_meeting_for_event: CustomAction<{ calendarEventId: string }, { id: string, meeting: { Meeting: MeetingInfo }, host: Attendee }>, 
     join_meeting_for_event: CustomAction<{ calendarEventId: string }, { meeting: { Meeting: MeetingInfo } }>, 
+    read: CustomAction<{ id: string }, Meeting>,
   },
   webhooks: {
     configure: CustomAction<{ url: string, secret: string, subscriptions?: WebhookSubscriptionsType }, { }>,
@@ -369,7 +388,12 @@ export type PublicActions = {
       { id?: string, email?: string, phone?: string, password: string, durationInSeconds: number }, 
       { authToken: string }
     >,
-    register: CustomAction<{ emailConsent?: boolean, fname?: string, lname?: string, email: string, password: string }, {  }>,
+    register: CustomAction<{ 
+      emailConsent?: boolean, fname?: string, lname?: string, email: string, password: string,
+      termsVersion?: string, termsSigned?: Date,
+    }, {  }>,
+    request_password_reset: CustomAction<{ email: string, businessId: string }, { }>,
+    reset_password: CustomAction<{ resetToken: string, newPassword: string, businessId: string }, { }>,
   },
   users: {
     request_password_reset: CustomAction<{ email: string }, { }>,
@@ -523,9 +547,9 @@ export const schema: SchemaV1 = build_schema({
       lastActive: { 
         validator: dateValidator,
       },
-      lastLogout: { 
-        validator: dateValidator,
-      },
+      lastLogout: { validator: dateValidator },
+      termsSigned: { validator: dateValidator },
+      termsVersion: { validator: stringValidator100 },
       lastCommunication: { 
         redactions: ['enduser'],
         validator: dateValidator,
@@ -642,15 +666,39 @@ export const schema: SchemaV1 = build_schema({
         path: '/register-as-enduser',
         description: "Allows and enduser to register directly with an email and password",
         parameters: { 
+          email: { validator: emailValidator, required: true }, 
+          password: { validator: stringValidator100, required: true },
           fname: { validator: nameValidator },
           lname: { validator: nameValidator },
           emailConsent: { validator: booleanValidator },
-          email: { validator: emailValidator, required: true }, 
-          password: { validator: stringValidator100, required: true },
+          termsSigned: { validator: dateValidator },
+          termsVersion: { validator: stringValidator100 },
         },
         returns: { } //authToken: { validator: stringValidator5000 } },
-
       },
+      request_password_reset: {
+        op: "custom", access: 'update', method: "post",
+        name: 'Request Password Reset',
+        path: '/request-enduser-password-reset',
+        description: "Sends a password reset email",
+        parameters: { 
+          email: { validator: emailValidator, required: true },
+          businessId: { validator: mongoIdStringValidator, required: true },
+        },
+        returns: { },
+      },
+      reset_password: {
+        op: "custom", access: 'update', method: "post",
+        name: 'Reset Password',
+        path: '/reset-enduser-password',
+        description: "For a code generated by request-enduser-password-reset, sets a new password",
+        parameters: { 
+          resetToken: { validator: stringValidator250, required: true },
+          newPassword: { validator: passwordValidator, required: true },
+          businessId: { validator: mongoIdStringValidator, required: true },
+        },
+        returns: { },
+      }, 
     },
   },
   enduser_status_updates: {
@@ -1171,7 +1219,7 @@ export const schema: SchemaV1 = build_schema({
       }
     },
     defaultActions: DEFAULT_OPERATIONS,
-    enduserActions: { create: {}, read: {}, readMany: {}, display_info: {} },
+    enduserActions: { create: {}, read: {}, readMany: {}, display_info: {}, mark_read: {} },
     customActions: {
       join_room: {
         op: "custom", access: 'update', method: "post",
@@ -1183,6 +1231,16 @@ export const schema: SchemaV1 = build_schema({
           room: { validator:  'Room' }, 
         } as any // add room eventually, when validator defined
       },
+      mark_read: {
+        op: "custom", access: 'update', method: "post",
+        name: 'Mark Read',
+        path: '/mark-chat-room-read',
+        description: "Marks the conversation read by the authenticated user",
+        parameters: { id: { validator: mongoIdStringValidator, required: true } },
+        returns: { 
+          updated: { validator:  'Room' }, 
+        } as any // add room eventually, when validator defined
+      },
       display_info: {
         op: "custom", access: 'read', method: "get",
         name: 'Attendee display info',
@@ -1285,9 +1343,30 @@ export const schema: SchemaV1 = build_schema({
         }
       }],
     },
-    defaultActions: { read: {}, readMany: {}, update: { description: "Users can only be updated by self or an organization admin"} },
+    defaultActions: { 
+      create: { adminOnly: true },
+      read: {}, readMany: {}, update: { description: "Users can only be updated by self or an organization admin"} 
+    },
     enduserActions: { display_info: {}, read: {}, readMany: {} },
     customActions: {
+      generate_auth_token: {
+        op: "custom", access: 'create', method: "get",
+        name: 'Generate authToken (Admin Only)',
+        path: '/generate-auth-token',
+        description: "Generates an authToken for a user or enduser. Useful for integrating a 3rd-party authentication process.",
+        parameters: { 
+          id: { validator: mongoIdStringValidator }, 
+          externalId: { validator: stringValidator250 },
+          email: { validator: emailValidator }, 
+          phone: { validator: phoneValidator },
+          durationInSeconds: { validator: nonNegNumberValidator },
+        },
+        returns: { 
+          authToken: { validator: stringValidator100, required: true },
+          enduser: { validator: 'enduser' as any, required: false },
+          user: { validator: 'user' as any, required: false },
+        },
+      },
       display_info: {
         op: "custom", access: 'read', method: "get",
         name: 'User Display Info',
@@ -1328,7 +1407,7 @@ export const schema: SchemaV1 = build_schema({
         description: "For a code generated by request-password-reset, sets a new password",
         parameters: { 
           resetToken: { validator: stringValidator250, required: true },
-          newPassword: { validator: stringValidator250, required: true },
+          newPassword: { validator: passwordValidator, required: true },
         },
         returns: { },
       }, 
@@ -1601,6 +1680,9 @@ export const schema: SchemaV1 = build_schema({
     constraints: {
       unique: [], 
       relationship: [],
+      access: [
+        { type: 'filter', field: 'attendees.id' }, 
+      ]
     },
     defaultActions: { 
       readMany: {
@@ -1608,7 +1690,16 @@ export const schema: SchemaV1 = build_schema({
         adminOnly: true,
       }
     },
+    enduserActions: { my_meetings: {}, join_meeting_for_event: {}, read: {} },
     customActions: {
+      read: {
+        op: "read", access: 'read', method: "get",
+        description: "Get a meeting",
+        parameters: { 
+          id: { validator: mongoIdStringValidator },
+        },
+        returns: 'meeting' as any,
+      },
       start_meeting: {
         op: "custom", access: 'create', method: "post",
         name: 'Start Meeting',
@@ -1704,7 +1795,6 @@ export const schema: SchemaV1 = build_schema({
         },
       },
     },
-    enduserActions: { my_meetings: {}, join_meeting_for_event: {} },
     fields: {
       ...BuiltInFields, 
       // all fields are updatable by custom endpoints only
@@ -1835,6 +1925,7 @@ export const schema: SchemaV1 = build_schema({
         validator: previousFormFieldsValidator,
         examples: [[{ type: 'root', info: { } } as PreviousFormField]]
       },
+      flowchartUI: { validator: flowchartUIValidator },
       options: { validator: objectAnyFieldsAnyValuesValidator }, // todo: more restriction
       description: { validator: stringValidator250 }, 
       intakeField: { validator: stringValidator }, // todo: ensure built-ins are ignored
@@ -1884,6 +1975,7 @@ export const schema: SchemaV1 = build_schema({
       responses: { validator: formResponsesValidator },
     },
     defaultActions: DEFAULT_OPERATIONS,
+    enduserActions: { prepare_form_response: {}, info_for_access_code: {}, submit_form_response: {}, read: {}, readMany: {} },
     customActions: { 
       prepare_form_response: {
         op: "custom", access: 'create', method: "post",
@@ -1913,7 +2005,21 @@ export const schema: SchemaV1 = build_schema({
         returns: {
           formResponse: 'form response' as any,
         },
-      }
+      },
+      info_for_access_code: {
+        op: "custom", access: 'read', method: "get",
+        name: 'Info for Access Code',
+        path: '/form-info-for-access-code',
+        description: "With an accessCode, retrieves the relevant info for submitting a form",
+        parameters: { 
+          accessCode: { validator: stringValidator250, required: true },
+        },
+        returns: {
+          form: 'form' as any,
+          fields: 'form fields' as any,
+          response: 'form response' as any,
+        },
+      },
     },
     publicActions: {
       session_for_public_form: {
@@ -1937,7 +2043,6 @@ export const schema: SchemaV1 = build_schema({
         },
       },
     },
-    enduserActions: { prepare_form_response: {}, submit_form_response: {}, read: {}, readMany: {} },
   },
   webhooks: {
     info: {
@@ -2104,6 +2209,7 @@ export const schema: SchemaV1 = build_schema({
       },
       description: { validator: stringValidator5000 },
       meetingId: { validator: mongoIdStringValidator, readonly: true },
+      meetingStatus: { validator: meetingStatusValidator },
       chatRoomId: { 
         validator: mongoIdStringValidator,
         dependencies: [{
@@ -2215,7 +2321,8 @@ export const schema: SchemaV1 = build_schema({
           }, 
         }]
       },
-      conditions: { validator: listOfAutomationConditionsValidator }
+      conditions: { validator: listOfAutomationConditionsValidator },
+      flowchartUI: { validator: flowchartUIValidator },
     }
   },
   automated_actions: {
@@ -2465,6 +2572,14 @@ export const schema: SchemaV1 = build_schema({
         validator: stringValidator25000,
         examples: ["This is the template message......"],
       },
+      type: {
+        validator: managedContentRecordTypeValidator,
+        updatesDisabled: true,
+      },
+      attachments: {
+        validator: listOfChatAttachmentsValidator,
+      },
+      headerPhoto: { validator: stringValidator250 },
       publicRead: { validator: booleanValidator },
       mode: { validator: messageTemplateModeValidator, },
       files: { validator: listOfStringsValidator },
@@ -2744,6 +2859,7 @@ export const schema: SchemaV1 = build_schema({
       roles: { validator: listOfStringsValidator },
       skills: { validator: listOfStringsValidator },
       themeColor: { validator: stringValidator100 },
+      customPortalURL: { validator: stringValidator250 },
     },
   },