@tellescope/schema 1.2.4 → 1.3.2

package/src/schema.ts

@@ -37,6 +37,9 @@ import {
   Enduser,
   Journey,
   FormResponse,
+  FormField,
+  Form,
+  Meeting,
 } from "@tellescope/types-client"
 
 import {
@@ -106,6 +109,8 @@ import {
   previousFormFieldsValidator,
   numberValidator,
   organizationThemeValidator,
+  managedContentRecordTypeValidator,
+  passwordValidator,
 } from "@tellescope/validation"
 
 import {
@@ -313,6 +318,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 }>,
@@ -336,6 +346,7 @@ export type CustomActions = {
   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,6 +355,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 }, { 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 }, { }>,
@@ -358,7 +372,7 @@ export type CustomActions = {
   post_likes: { 
     create: CustomAction<{ postId: string, forumId: string }, { }>,
     unlike_post: CustomAction<{ postId: string, forumId: string }, { }>,
-  }
+  },
 } 
 
 export type PublicActions = {
@@ -368,6 +382,8 @@ export type PublicActions = {
       { authToken: string }
     >,
     register: CustomAction<{ emailConsent?: boolean, fname?: string, lname?: string, email: string, password: string }, {  }>,
+    request_password_reset: CustomAction<{ email: string, businessId: string }, { }>,
+    reset_password: CustomAction<{ resetToken: string, newPassword: string, businessId: string }, { }>,
   },
   users: {
     request_password_reset: CustomAction<{ email: string }, { }>,
@@ -647,8 +663,30 @@ export const schema: SchemaV1 = build_schema({
           password: { validator: stringValidator100, required: true },
         },
         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: {
@@ -900,8 +938,9 @@ export const schema: SchemaV1 = build_schema({
             if (method === 'update') return
 
             const e = deps[enduserId ?? ''] as Enduser
+            if (!e) return // not in cache, permit by default, likely during an update
             if (!e?.email) return "Missing email"
-            if (!e?.emailConsent) return "Missing email consent"
+            // if (!e?.emailConsent) return "Missing email consent"
           }
         }
       ],
@@ -1026,7 +1065,7 @@ export const schema: SchemaV1 = build_schema({
             const e = deps[enduserId ?? ''] as Enduser
             if (!e) return // not in cache, permit by default, likely during an update
             if (!e.phone) return "Missing phone"
-            if (!e.phoneConsent) return "Missing phone consent"
+            // if (!e.phoneConsent) return "Missing phone consent"
           }
         }
       ],
@@ -1161,14 +1200,14 @@ export const schema: SchemaV1 = build_schema({
         validator: dateValidator,
       },
       tags: {
-        validator: listOfStringsValidator,
+        validator: listOfStringsValidatorEmptyOk,
       },
       infoForUser: { // todo: access-permissions allow updates for self only (when non-admin)
         validator: chatRoomUserInfoValidator,
       }
     },
     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",
@@ -1180,6 +1219,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',
@@ -1283,6 +1332,7 @@ export const schema: SchemaV1 = build_schema({
       }],
     },
     defaultActions: { read: {}, readMany: {}, update: { description: "Users can only be updated by self or an organization admin"} },
+    enduserActions: { display_info: {}, read: {}, readMany: {} },
     customActions: {
       display_info: {
         op: "custom", access: 'read', method: "get",
@@ -1324,28 +1374,31 @@ 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: { },
       }, 
     },
-    enduserActions: { display_info: {} },
     fields: {
       ...BuiltInFields, 
       email: {
         validator: emailValidator,
         required: true,
-        examples: ['test@tellescope.com']
+        examples: ['test@tellescope.com'],
+        redactions: ['enduser'],
       },
       phone: {
         validator: phoneValidator,
+        redactions: ['enduser'],
       },
       fields: {
         validator: fieldsValidator,
+        redactions: ['enduser'],
       },
       username: {
         validator: subdomainValidator,
         readonly: true, // able to set once, then not change (for now, due to email configuration)
+        redactions: ['enduser'],
       },
       fname: {
         validator: nameValidator,
@@ -1367,6 +1420,7 @@ export const schema: SchemaV1 = build_schema({
       roles: {
         validator: listOfStringsValidator,
         updatesDisabled: true, // implement with separate endpoint with tight restrictions
+        redactions: ['enduser'],
       },
       skills: {
         validator: listOfStringsValidator,
@@ -1374,9 +1428,11 @@ export const schema: SchemaV1 = build_schema({
       hashedPassword: {
         validator: stringValidator,
         readonly: true, // update via separate password reset function
+        redactions: ['enduser'],
       },
       notificationPreferences: {
         validator: notificationPreferencesValidator,
+        redactions: ['enduser'],
       },
       avatar: {
         validator: stringValidator100,
@@ -1591,6 +1647,9 @@ export const schema: SchemaV1 = build_schema({
     constraints: {
       unique: [], 
       relationship: [],
+      access: [
+        { type: 'filter', field: 'attendees.id' }, 
+      ]
     },
     defaultActions: { 
       readMany: {
@@ -1598,7 +1657,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',
@@ -1664,9 +1732,36 @@ export const schema: SchemaV1 = build_schema({
         description: "Gets meetings for the current user.",
         parameters: {},
         returns: { validator: meetingsListValidator, required: true },
-      }
+      },
+      start_meeting_for_event: {
+        op: "custom", access: 'create', method: "post",
+        name: 'Start Scheduled Meeting',
+        path: '/start-meeting-for-event',
+        description: "Generates an video meeting room",
+        parameters: { 
+          calendarEventId: { validator: mongoIdStringValidator, required: true },
+        },
+        returns: { 
+          id: { validator: mongoIdStringValidator, required: true },
+          meeting: { validator: meetingInfoValidator, required: true },
+          host: { validator: attendeeValidator, required: true },
+        },
+      },
+      join_meeting_for_event: {
+        op: "custom", access: 'update', method: "post",
+        name: 'Join Scheduled Meeting',
+        path: '/join-meeting-for-event',
+        description: "Generates an video meeting room",
+        parameters: { 
+          calendarEventId: { validator: mongoIdStringValidator, required: true },
+        },
+        returns: { 
+          id: { validator: mongoIdStringValidator, required: true },
+          meeting: { validator: meetingInfoValidator, required: true },
+          attendee: { validator: attendeeValidator, required: true },
+        },
+      },
     },
-    enduserActions: { my_meetings: {} },
     fields: {
       ...BuiltInFields, 
       // all fields are updatable by custom endpoints only
@@ -1846,6 +1941,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",
@@ -1875,7 +1971,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: {
@@ -1899,7 +2009,6 @@ export const schema: SchemaV1 = build_schema({
         },
       },
     },
-    enduserActions: { prepare_form_response: {}, submit_form_response: {} },
   },
   webhooks: {
     info: {
@@ -2029,7 +2138,23 @@ export const schema: SchemaV1 = build_schema({
       ]
     },
     defaultActions: DEFAULT_OPERATIONS,
-    customActions: {},
+    customActions: {
+      start_meeting: {
+        op: "custom", access: 'create', method: "post",
+        name: 'Start Meeting',
+        path: '/start-meeting-for-event',
+        description: "Generates an video meeting room",
+        parameters: { 
+          attendees: { validator: listOfUserIndentitiesValidator },
+          publicRead: { validator: booleanValidator },
+        },
+        returns: { 
+          id: { validator: mongoIdStringValidator, required: true },
+          meeting: { validator: meetingInfoValidator, required: true },
+          host: { validator: attendeeValidator, required: true },
+        },
+      },
+    },
     enduserActions: { read: {}, readMany: {} },
     fields: {
       ...BuiltInFields, 
@@ -2049,6 +2174,8 @@ export const schema: SchemaV1 = build_schema({
         required: true,
       },
       description: { validator: stringValidator5000 },
+      meetingId: { validator: mongoIdStringValidator, readonly: true },
+      meetingStatus: { validator: meetingStatusValidator },
       chatRoomId: { 
         validator: mongoIdStringValidator,
         dependencies: [{
@@ -2067,6 +2194,7 @@ export const schema: SchemaV1 = build_schema({
         initializer: () => [],
       },
       publicRead: { validator: booleanValidator }, 
+      enableVideoCall: { validator: booleanValidator }, 
       displayImage: { validator: stringValidator }, 
       fields: { validator: fieldsValidator }, 
     }
@@ -2409,9 +2537,18 @@ 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 },
-      tags: { validator: listOfStringsValidator },
+      tags: { validator: listOfStringsValidatorEmptyOk },
     }
   },
   forums: {
@@ -2473,6 +2610,11 @@ export const schema: SchemaV1 = build_schema({
         validator: nonNegNumberValidator,
         initializer: () => 0,
       },
+      title: {
+        validator: stringValidator5000,
+        required: true,
+        examples: ["This is the template message......"],
+      },
       textContent: {
         validator: stringValidator25000,
         required: true,
@@ -2574,6 +2716,7 @@ export const schema: SchemaV1 = build_schema({
       access: [{ type: 'dependency', foreignModel: 'forums', foreignField: '_id', accessField: 'forumId' }]
     },
     defaultActions: { read: {}, readMany: {}, delete: {} }, // create is custom
+    enduserActions: { create: {}, unlike_post: {}, readMany: {} },
     customActions: { 
       create: {
         op: "custom", access: 'create', method: "post",
@@ -2598,7 +2741,6 @@ export const schema: SchemaV1 = build_schema({
         returns: { } //authToken: { validator: stringValidator5000 } },
       },
     },
-    enduserActions: { create: {}, unlike_post: {} },
     fields: {
       ...BuiltInFields, 
       // creator: {
@@ -2682,6 +2824,7 @@ export const schema: SchemaV1 = build_schema({
       roles: { validator: listOfStringsValidator },
       skills: { validator: listOfStringsValidator },
       themeColor: { validator: stringValidator100 },
+      customPortalURL: { validator: stringValidator250 },
     },
   },