@tellescope/validation 1.6.2 → 1.7.4

package/src/validation.ts

@@ -170,6 +170,13 @@ import {
   CalendarEventPortalSettings,
   AvailabilityBlock,
   IndexUpdate,
+  FormResponseAnswerAddress,
+  ListQueryQualifier,
+  AutomationTriggerEventType,
+  AutomationTriggerEvents,
+  AutomationTriggerActionType,
+  AutomationTriggerActions,
+  AutomationTriggerStatus,
 } from "@tellescope/types-models"
 import {
   DatabaseRecord,
@@ -957,6 +964,10 @@ export const numberValidator = numberValidatorBuilder({ lower: -10000000000000,
 export const numberValidatorOptional = numberValidatorBuilder({ lower: -10000000000000, upper: 10000000000000, isOptional: true, emptyStringOk: true }) // max is 2286 in UTC MS
 export const fileSizeValidator = numberValidatorBuilder({ lower: 0, upper: MAX_FILE_SIZE })
 
+export const numberOrStringValidatorEmptyOkay = orValidator({
+  number: numberValidator,
+  string: stringValidator5000EmptyOkay,
+})
 export const numberOrStringValidatorOptional = orValidator({
   number: numberValidatorOptional,
   string: stringValidatorOptional
@@ -1038,6 +1049,67 @@ export const exactMatchValidatorOptional = <T extends string | null>(matches: T[
 })
 export const exactMatchListValidator = <T extends string | null>(matches: T[]) => listValidator(exactMatchValidator(matches))
 
+export const VALID_STATES: string[] = [
+  "AK", 
+  "AL", 
+  "AR", 
+  "AS", 
+  "AZ", 
+  "CA", 
+  "CO", 
+  "CT", 
+  "DC", 
+  "DE", 
+  "FL", 
+  "GA", 
+  "GU", 
+  "HI", 
+  "IA", 
+  "ID", 
+  "IL", 
+  "IN", 
+  "KS", 
+  "KY", 
+  "LA", 
+  "MA", 
+  "MD", 
+  "ME", 
+  "MI", 
+  "MN", 
+  "MO", 
+  "MP", 
+  "MS", 
+  "MT", 
+  "NC", 
+  "ND", 
+  "NE", 
+  "NH", 
+  "NJ", 
+  "NM", 
+  "NV", 
+  "NY", 
+  "OH", 
+  "OK", 
+  "OR", 
+  "PA", 
+  "PR", 
+  "RI", 
+  "SC", 
+  "SD", 
+  "TN", 
+  "TX", 
+  "UM", 
+  "UT", 
+  "VA", 
+  "VI", 
+  "VT", 
+  "WA", 
+  "WI", 
+  "WV",
+  "WY",
+]
+export const stateValidator = exactMatchValidator(VALID_STATES)
+
 export const journeysValidator: ValidatorDefinition<Indexable> = {
   validate: (options={}) => build_validator(
     (journeys) => {
@@ -1116,7 +1188,11 @@ export const fileTypeValidator: ValidatorDefinition<string> = {
 
       return s
     }, 
-    { ...options, listOf: false }
+    { 
+      ...options, 
+      emptyStringOk: true,  // allow empty string for unknown file types
+      listOf: false,
+    }
   ),
   getExample: () => 'text/plain',
   getType: getTypeString,
@@ -1239,11 +1315,13 @@ const _FORM_FIELD_TYPES: { [K in FormFieldType]: any } = {
   "Question Group": '',
   "Table Input": '',
   description: '',
+  Address: '',
 }
 export const FORM_FIELD_TYPES = Object.keys(_FORM_FIELD_TYPES) as FormFieldType[]
 export const formFieldTypeValidator = exactMatchValidator<FormFieldType>(FORM_FIELD_TYPES)
 
 export const FORM_FIELD_VALIDATORS_BY_TYPE: { [K in FormFieldType | 'userEmail' | 'phoneNumber']: (value?: FormResponseValueAnswer[keyof FormResponseValueAnswer], options?: any, isOptional?: boolean) => any } = {
+  'Address': objectAnyFieldsAnyValuesValidator.validate(),
   'description': g => '',
   'Table Input': (g) => Array.isArray(g) ? g : [],
   'Question Group': (g) => Array.isArray(g) ? g : [],
@@ -1529,6 +1607,16 @@ export const formResponseAnswerValidator = orValidator<{ [K in FormFieldType]: F
       id: mongoIdStringRequired,
     }))
   }),
+  "Address": objectValidator<FormResponseAnswerAddress>({
+    type: exactMatchValidator(['Address']),
+    value: objectValidator<FormResponseAnswerAddress['value']>({ 
+      addressLineOne: stringValidator1000,
+      addressLineTwo: stringValidator1000Optional,
+      city: stringValidator1000,
+      state: stateValidator,
+      zipCode: stringValidator100
+    })
+  }),
   "Table Input": objectValidator<FormResponseAnswerTable>({
     type: exactMatchValidator(['Table Input']),
     value: listValidatorOptionalOrEmptyOk( // optional to support optional Table Input questions
@@ -2393,71 +2481,10 @@ export const enduserFormResponseForEventValidator = objectValidator<EnduserFormR
 export const enduserFormResponsesForEventValidator = listValidatorEmptyOk(enduserFormResponseForEventValidator)
 
 export const genericUnitWithQuantityValidator = objectValidator<GenericQuantityWithUnit>({
-  value: stringValidator5000EmptyOkay,
+  value: numberOrStringValidatorEmptyOkay,
   unit: stringValidator1000,
 })
 
-export const VALID_STATES: string[] = [
-  "AK", 
-  "AL", 
-  "AR", 
-  "AS", 
-  "AZ", 
-  "CA", 
-  "CO", 
-  "CT", 
-  "DC", 
-  "DE", 
-  "FL", 
-  "GA", 
-  "GU", 
-  "HI", 
-  "IA", 
-  "ID", 
-  "IL", 
-  "IN", 
-  "KS", 
-  "KY", 
-  "LA", 
-  "MA", 
-  "MD", 
-  "ME", 
-  "MI", 
-  "MN", 
-  "MO", 
-  "MP", 
-  "MS", 
-  "MT", 
-  "NC", 
-  "ND", 
-  "NE", 
-  "NH", 
-  "NJ", 
-  "NM", 
-  "NV", 
-  "NY", 
-  "OH", 
-  "OK", 
-  "OR", 
-  "PA", 
-  "PR", 
-  "RI", 
-  "SC", 
-  "SD", 
-  "TN", 
-  "TX", 
-  "UM", 
-  "UT", 
-  "VA", 
-  "VI", 
-  "VT", 
-  "WA", 
-  "WI", 
-  "WV",
-  "WY",
-]
-export const stateValidator = exactMatchValidator(VALID_STATES)
-
 export const stateCredentialValidator = objectValidator<StateCredentialInfo>({
   expiresAt: dateValidatorOptional,
   state: stateValidator,
@@ -2543,6 +2570,44 @@ export const calendarEventPortalSettingsValidator = objectValidator<CalendarEven
   hideUsers: booleanValidatorOptional,
 })
 
+const _AUTOMATION_TRIGGER_EVENT_TYPES: { [K in AutomationTriggerEventType]: any } = {
+  "Form Submitted": true,
+}
+export const AUTOMATION_TRIGGER_EVENT_TYPES = Object.keys(_AUTOMATION_TRIGGER_EVENT_TYPES) as AutomationTriggerEventType[]
+
+export const automationTriggerEventValidator = orValidator<{ [K in AutomationTriggerEventType]: AutomationTriggerEvents[K] } >({
+  "Form Submitted": objectValidator<AutomationTriggerEvents["Form Submitted"]>({
+    type: exactMatchValidator(['Form Submitted']),
+    info: objectValidator<AutomationTriggerEvents['Form Submitted']['info']>({
+      formId: mongoIdStringRequired,
+    }),
+    conditions: optionalEmptyObjectValidator,
+    // info: objectValidator<AutomationTriggerEvents['Form Submitted']['conditions']>({ }),
+  }), 
+})
+
+const _AUTOMATION_TRIGGER_ACTION_TYPES: { [K in AutomationTriggerActionType]: any } = {
+  "Add To Journey": true,
+}
+export const AUTOMATION_TRIGGER_ACTION_TYPES = Object.keys(_AUTOMATION_TRIGGER_ACTION_TYPES) as AutomationTriggerActionType[]
+
+export const automationTriggerActionValidator = orValidator<{ [K in AutomationTriggerActionType]: AutomationTriggerActions[K] } >({
+  "Add To Journey": objectValidator<AutomationTriggerActions["Add To Journey"]>({
+    type: exactMatchValidator(['Add To Journey']),
+    info: objectValidator<AutomationTriggerActions['Add To Journey']['info']>({
+      journeyId: mongoIdStringRequired,
+    }),
+  }), 
+})
+
+
+const _AUTOMATION_TRIGGER_STATUSES: { [K in AutomationTriggerStatus]: any } = {
+  Active: true,
+  Inactive: true,
+}
+export const AUTOMATION_TRIGGER_STATUSES = Object.keys(_AUTOMATION_TRIGGER_STATUSES) as AutomationTriggerStatus[]
+export const automatioNTriggerStatusValidator = exactMatchValidator<AutomationTriggerStatus>(AUTOMATION_TRIGGER_STATUSES)
+
 // for each model name, this should be optional, but when a model name is provided, all CRUD fields should be required
 // if this changes (e.g. CRUD fields are made optional), must merge better in authentication.ts in API
 export const accessPermissionValidator = objectValidator<AccessForResource>({
@@ -2606,12 +2671,14 @@ export const accessPermissionsValidator = objectValidator<AccessPermissions>({
   phone_calls: accessPermissionValidator,
   background_errors: accessPermissionValidator,
   enduser_views: accessPermissionValidator,
+  automation_triggers: accessPermissionValidator,
 
   // deprecated but for backwards compatibility
   apiKeys: accessPermissionValidator,
 })
 
 export const organizationLimitsValidator = objectValidator<OrganizationLimits>({
+  automation_triggers: numberValidatorOptional,
   background_errors: numberValidatorOptional,
   enduser_views: numberValidatorOptional,
   availability_blocks: numberValidatorOptional,
@@ -2729,11 +2796,23 @@ export const integrationTitleValidator = exactMatchValidator<IntegrationsTitleTy
   OUTLOOK_INTEGRATIONS_TITLE,
 ])
 
+const _LIST_QUERY_QUALIFIERS: { [K in ListQueryQualifier]: any} = {
+  "One Of": '',
+  "All Of": "",
+} 
+export const LIST_QUERY_QUALIFIERS = Object.keys(_LIST_QUERY_QUALIFIERS) as ListQueryQualifier[]
+export const listQueryQualifiersValidator = exactMatchValidator<ListQueryQualifier>(LIST_QUERY_QUALIFIERS)
+
+
 export const analyticsQueryValidator = orValidator<{ [K in AnalyticsQueryType]: AnalyticsQueryForType[K] } >({
   Endusers: objectValidator<AnalyticsQueryForType['Endusers']>({
     resource: exactMatchValidator<'Endusers'>(['Endusers']),
     filter: objectValidator<AnalyticsQueryFilterForType['Endusers']>({
       activeSince: dateOptionalOrEmptyStringValidator,
+      "Submitted Forms": objectValidator<AnalyticsQueryFilterForType['Endusers']['Submitted Forms']>({
+        qualifier: listQueryQualifiersValidator,
+        formIds: listOfMongoIdStringValidator,
+      }, { isOptional: true })
     }, { isOptional: true, emptyOk: true }),
     info: orValidator<{ [K in keyof AnalyticsQueryInfoForType['Endusers']]: AnalyticsQueryInfoForType['Endusers'][K] }>({
       "Total": objectValidator<AnalyticsQueryInfoForType['Endusers']['Total']>({
@@ -2744,12 +2823,6 @@ export const analyticsQueryValidator = orValidator<{ [K in AnalyticsQueryType]:
         method: exactMatchValidator<"Percentage">(['Percentage']),
         parameters: optionalEmptyObjectValidator,
       }),
-      "Submitted Forms": objectValidator<AnalyticsQueryInfoForType['Endusers']['Submitted Forms']>({
-        method: exactMatchValidator<"Submitted Forms">(['Submitted Forms']),
-        parameters: objectValidator<AnalyticsQueryInfoForType['Endusers']['Submitted Forms']['parameters']>({
-          formIds: listOfMongoIdStringValidator,
-        }),
-      }),
     })
   }), 
   "Calendar Events": objectValidator<AnalyticsQueryForType['Calendar Events']>({