@tellescope/schema 1.3.48 → 1.4.1

package/src/schema.ts

@@ -31,6 +31,7 @@ import {
   MeetingInfo,
   PreviousFormField,
   OrganizationTheme,
+  AvailabilityBlock,
 } from "@tellescope/types-models"
 
 import {
@@ -47,7 +48,7 @@ import {
 } from "@tellescope/types-client"
 
 import {
-  EscapeBuilder,
+  ValidatorDefinition,
 
   booleanValidator,
   dateValidator,
@@ -59,7 +60,7 @@ import {
   nameValidator,
   nonNegNumberValidator,
   mongoIdValidator,
-  mongoIdStringValidator,
+  mongoIdStringRequired as mongoIdStringValidator,
   listOfMongoIdStringValidator,
   preferenceValidator,
   objectAnyFieldsAnyValuesValidator,
@@ -99,7 +100,6 @@ import {
   listOfCalendarEventRemindersValidator,
   messageTemplateModeValidator,
   listOfAutomationConditionsValidator,
-  journeyStateUpdateValidator,
   chatRoomUserInfoValidator,
   CUDStringValidator,
   listOfRelatedRecordsValidator,
@@ -123,7 +123,7 @@ import {
   sessionTypeValidator,
   portalSettingsValidator,
   emailValidatorEmptyOkay,
-  phoneValidatorEmptyOkay,
+  phoneValidatorOptional,
   stringValidator1000,
   databaseFieldsValidator,
   databaseRecordValuesValidator,
@@ -132,6 +132,11 @@ import {
   portalBlocksValidator,
   enduserFormResponsesForEventValidator,
   enduserTasksForEventValidator,
+  stateCredentialsValidator,
+  stateValidator,
+  availabilityBlocksValidator,
+  weeklyAvailabilitiesValidator,
+  timezoneValidator,
 } from "@tellescope/validation"
 
 import {
@@ -143,9 +148,18 @@ import {
 } from "@tellescope/constants"
 import { response } from "express"
 
+export type RelationshipConstraintOptions<T> = {
+  updates?: Partial<T>
+}
 export type RelationshipConstraint<T> = {
   explanation: string; // human readable, for documentation purposes
-  evaluate: (v: T, dependencies: Indexable<Partial<DatabaseModel>>, session: UserSession | EnduserSession, method: 'create' | 'update') => string | void;
+  evaluate: (
+    v: T, 
+    dependencies: Indexable<Partial<DatabaseModel>>, 
+    session: UserSession | EnduserSession, 
+    method: 'create' | 'update',
+    options: RelationshipConstraintOptions<T>,
+  ) => string | void;
 }
 
 export type DependencyAccessConstraint <T> = { type: 'dependency', foreignModel: ModelName, foreignField: string, accessField: keyof T  }
@@ -170,7 +184,7 @@ 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
-  parameters?: { [index: string]: EscapeBuilder<any> }, 
+  parameters?: { [index: string]: ValidatorDefinition<any> }, 
 }
 
 export type DependencyDeletionAction = 'delete' | 'unset' | 'setNull' | 'nop'
@@ -193,7 +207,7 @@ export type RedactionReason = (
 )
 
 export type ModelFieldInfo <T, R> = {
-  validator: EscapeBuilder<R>,
+  validator: ValidatorDefinition<R>,
   readonly?:  boolean,
   required?:  boolean,
   updatesDisabled?: boolean,
@@ -361,7 +375,7 @@ export type CustomActions = {
     }>,
   },
   journeys: {
-    update_state: CustomAction<{ updates: Partial<JourneyState>, id: string, name: string }, { updated: Journey }>,
+    // update_state: CustomAction<{ updates: Partial<JourneyState>, id: string, name: string }, { updated: Journey }>,
     delete_states: CustomAction<{ id: string, states: string[] }, { updated: Journey }>,
   },
   endusers: {
@@ -424,7 +438,17 @@ export type CustomActions = {
     sync_integrations: CustomAction<{ enduserEmail: string }, { newEmails: Email[] }>, 
   },
   calendar_events: {
-    get_external_events_for_user: CustomAction<{ userId: string, from: Date, limit?: number }, { events: CalendarEvent[] }>, 
+    get_events_for_user: CustomAction<{ userId: string, from: Date, to?: Date, limit?: number }, { events: CalendarEvent[] }>, 
+    get_appointment_availability: CustomAction<{ 
+      from: Date, calendarEventTemplateId: string, to?: Date, restrictedByState?: boolean, limit?: number,
+    }, { 
+      availabilityBlocks: AvailabilityBlock[],
+    }>,
+    book_appointment: CustomAction<{ 
+      userId: string, startTime: Date, calendarEventTemplateId: string,
+    }, { 
+      createdEvent: CalendarEvent,
+    }>,
   },
 } 
 
@@ -475,6 +499,7 @@ export const build_schema = <T extends Schema>(schema: T) => schema
 export const schema: SchemaV1 = build_schema({
   endusers: {
     info: {
+      description: "Used to represent patients or other endusers. See Users for managing your team member's accounts.",
       sideEffects: {
         create: [sideEffects.handleJourneyStateChange],
         update: [sideEffects.handleJourneyStateChange],
@@ -529,7 +554,7 @@ export const schema: SchemaV1 = build_schema({
         redactions: ['enduser'],
       },
       phone: { 
-        validator: phoneValidatorEmptyOkay,
+        validator: phoneValidatorOptional,
         examples: ['+14155555555'],
         redactions: ['enduser'],
       },
@@ -612,6 +637,7 @@ export const schema: SchemaV1 = build_schema({
           },
         ]
       },
+      state: { validator: stateValidator },
       // recentMessagePreview: { 
       //   validator: stringValidator,
       // },
@@ -966,20 +992,20 @@ export const schema: SchemaV1 = build_schema({
       },
     },
     customActions: {
-      update_state: {
-        op: 'custom', access: 'update', method: "patch",
-        name: 'Update State',
-        path: '/journey/:id/state/:name',
-        description: "Updates a state in a journey. Endusers and automations are updated automatically.",
-        parameters: { 
-          id: { validator: mongoIdStringValidator },
-          name: { validator: stringValidator100 },
-          updates: { validator: journeyStateUpdateValidator, required: true },
-        },
-        returns: { 
-          updated: { validator: 'journey' as any }
-        },
-      },
+      // update_state: {
+      //   op: 'custom', access: 'update', method: "patch",
+      //   name: 'Update State',
+      //   path: '/journey/:id/state/:name',
+      //   description: "Updates a state in a journey. Endusers and automations are updated automatically.",
+      //   parameters: { 
+      //     id: { validator: mongoIdStringValidator },
+      //     name: { validator: stringValidator100 },
+      //     updates: { validator: journeyStateUpdateValidator, required: true },
+      //   },
+      //   returns: { 
+      //     updated: { validator: 'journey' as any }
+      //   },
+      // },
       delete_states: {
         op: 'custom', access: 'update', method: "delete",
         name: 'Delete States',
@@ -1461,19 +1487,32 @@ export const schema: SchemaV1 = build_schema({
     },
   },
   users: {
-    info: {},
+    info: {
+      description: "Used to represent your team member accounts. See Endusers for representing patients and other types of stakeholders.",
+    },
     constraints: { 
       unique: ['username'],
       globalUnique: ['email', 'phone'],
-      relationship: [{
-        explanation: "Only admin users can update others' profiles",
-        evaluate: ({ _id }, _, session) => {
-          if (_id && _id.toString() === session.id) return
-          if ((session as UserSession)?.roles?.includes('Admin')) return
+      relationship: [
+        {
+          explanation: "Only admin users can update others' profiles",
+          evaluate: ({ _id }, _, session) => {
+            if (_id && _id.toString() === session.id) return
+            if ((session as UserSession)?.roles?.includes('Admin')) return
 
-          return "Only admin users can update others' profiles"
+            return "Only admin users can update others' profiles"
+          }
+        }, {
+          explanation: "Only admin users can update user roles",
+          evaluate: ({ roles }, _, session, method, { updates }) => {
+            if ((session as UserSession)?.roles?.includes('Admin')) return // admin can do this
+            if (method === 'create') return // create already admin restricted
+            if (!updates?.roles) return // roles not provided
+
+            return "Only admin users can update others' profiles"
+          }
         }
-      }],
+      ],
     },
     defaultActions: { 
       create: { adminOnly: true }, createMany: { adminOnly: true }, delete: { adminOnly: true },
@@ -1588,12 +1627,11 @@ export const schema: SchemaV1 = build_schema({
       },
       roles: {
         validator: listOfStringsValidator,
-        updatesDisabled: true, // implement with separate endpoint with tight restrictions
         redactions: ['enduser'],
       },
       acknowledgedIntegrations: { validator: dateValidator },
       skills: {
-        validator: listOfStringsValidator,
+        validator: listOfStringsValidatorEmptyOk,
       },
       verifiedEmail: {
         updatesDisabled: true, // allow it to be set on creation by admin via API to streamline SSO support
@@ -1619,6 +1657,11 @@ export const schema: SchemaV1 = build_schema({
           },
         ]
       },
+      credentialedStates: {
+        validator: stateCredentialsValidator,
+      },
+      timezone: { validator: timezoneValidator },
+      weeklyAvailabilities: { validator: weeklyAvailabilitiesValidator },
     }
   },
   templates: {
@@ -1681,7 +1724,7 @@ export const schema: SchemaV1 = build_schema({
         validator: fileTypeValidator,
         required: true
       },
-      enduserId: {
+      enduserId: { // deleted as side effect of enduser delete
         validator: mongoIdStringValidator,
       },
       secureName: {
@@ -2322,22 +2365,53 @@ export const schema: SchemaV1 = build_schema({
     },
     defaultActions: DEFAULT_OPERATIONS,
     customActions: {
-      get_external_events_for_user: {
+      get_events_for_user: {
         op: "custom", access: 'read', method: "get",
-        name: 'Get External Events for User',
-        path: '/external-events-for-user',
-        description: "Gets events from external calendars, formatted as a Tellescope event",
+        name: 'Get Events for User (Including Integrations)',
+        path: '/events-for-user',
+        description: "Combines internal and external events, formatted as a Tellescope events",
         parameters: { 
           userId: { validator: mongoIdStringValidator, required: true },
           from: { validator: dateValidator, required: true },
+          to: { validator: dateValidator },
           limit: { validator: nonNegNumberValidator },
         },
         returns: { 
           events: { validator: 'calendar_events' as any }
         },
       },
+      get_appointment_availability: {
+        op: "custom", access: 'read', method: "get",
+        name: 'Get Appointment Availability for a Calendar Event Type',
+        path: '/calendar-availability',
+        description: "Gets availability blocks for different users based on their internal and external calendars",
+        parameters: {  
+          calendarEventTemplateId: { validator: mongoIdStringValidator, required: true },
+          from: { validator: dateValidator, required: true },
+          restrictedByState: { validator: booleanValidator },
+          to: { validator: dateValidator },
+          limit: { validator: nonNegNumberValidator },
+        },
+        returns: { 
+          availabilityBlocks: { validator: availabilityBlocksValidator, required: true }
+        },
+      },
+      book_appointment: {
+        op: "custom", access: 'create', method: "post",
+        name: 'Book Appointment',
+        path: '/book-appointment',
+        description: "Books an appointment with a given user if available",
+        parameters: {  
+          calendarEventTemplateId: { validator: mongoIdStringValidator, required: true }, 
+          userId: { validator: mongoIdStringValidator, required: true },
+          startTime: { validator: dateValidator, required: true },
+        },
+        returns: { 
+          createdEvent: { validator: 'calenar_event' as any },
+        },
+      },
     },
-    enduserActions: { read: {}, readMany: {} },
+    enduserActions: { read: {}, readMany: {}, get_appointment_availability: {}, book_appointment: {} },
     fields: {
       ...BuiltInFields, 
       title: {
@@ -2391,7 +2465,7 @@ export const schema: SchemaV1 = build_schema({
           dependsOn: ['calendar_event_templates'],
           dependencyField: '_id',
           relationship: 'foreignKey',
-          onDependencyDelete: 'delete',
+          onDependencyDelete: 'nop',
         }]
       }, 
       publicRead: { validator: booleanValidator }, 
@@ -2402,6 +2476,8 @@ export const schema: SchemaV1 = build_schema({
       sharedContentIds: { validator: listOfMongoIdStringValidatorEmptyOk },
       enduserFormResponses: { validator: enduserFormResponsesForEventValidator },
       enduserTasks: { validator: enduserTasksForEventValidator },
+      location: { validator: stringValidator1000 },
+      phone: { validator: stringValidator100 }, // leave more generous than phone validator in favor of lower friction
     }
   },
   calendar_event_templates: {
@@ -3122,7 +3198,7 @@ export const schema: SchemaV1 = build_schema({
       subscriptionPeriod: { validator: numberValidator },
       logoVersion: { validator: numberValidator },
       faviconVersion: { validator: numberValidator },
-      roles: { validator: listOfStringsValidator },
+      roles: { validator: listOfStringsValidatorEmptyOk },
       skills: { validator: listOfStringsValidator },
       themeColor: { validator: stringValidator100 },
       customPortalURL: { validator: stringValidator250 },
@@ -3223,6 +3299,7 @@ export const schema: SchemaV1 = build_schema({
         validator: portalBlocksValidator,
       },
       disabled: { validator: booleanValidator },
+      mobileBottomNavigationPosition: { validator: nonNegNumberValidator },
     },
   }, 
   enduser_tasks: {
@@ -3255,12 +3332,8 @@ export const schema: SchemaV1 = build_schema({
           onDependencyDelete: 'delete',
         }]
       },
-      completedAt: {
-        validator: dateValidator,
-      },
-      description: {
-        validator: stringValidator1000,
-      },
+      completedAt: { validator: dateValidator },
+      description: { validator: stringValidator1000 },
     },
   },
   care_plans: {