@tellescope/validation 0.0.7 → 0.0.11

package/src/validation.ts

@@ -1,6 +1,27 @@
-//import "@tellescope/types"
 import { ObjectId } from "bson"
 
+import {
+  CustomUpdateOptions,
+  Indexable,
+  JSONType,
+} from "@tellescope/types-utilities"
+
+import {
+  CustomField,
+  Preference,
+  JourneyState,
+  JourneyStatePriority,
+  EmailEncoding,
+  ChatRoomTopic,
+  ChatRoomType,
+  AccountType,
+  MessageTemplateType,
+  MeetingStatus,
+  SessionType,
+  AttendeeInfo,
+  MeetingInfo,
+} from "@tellescope/types-models"
+
 import {
   RequestHandler,
   Request,
@@ -12,6 +33,7 @@ export const {
   isEmail,
   isMobilePhone,
   isMongoId,
+  isMimeType,
 } = v
 
 // import {
@@ -25,43 +47,44 @@ import {
   to_object_id,
 } from "@tellescope/utilities"
 
-// type EscapeWithOptions<R=any> = (o: ValidatorOptions) => (v: JSONType) => R
-// type EscapeFunction<R=any> = (v: JSONType) => R
-// type EscapeToList<R=any> = EscapeFunction<R[]>
-
-// interface ValidatorOptions {
-//   maxLength?: number;
-//   minLength?: number; 
-//   shouldTruncate?: boolean; 
-//   toLower?: boolean;
-//   isOptional?: boolean; 
-//   emptyStringOk?: boolean; 
-//   emptyListOk?: boolean; 
-//   nullOk?: boolean;
-//   isObject?: boolean; 
-//   isNumber?: boolean; 
-//   listOf?: boolean; 
-//   isBoolean?: boolean;
-//   errorMessage?: string;
-//   trim?: boolean;
-// }  
-// interface ValidatorOptionsForValue extends ValidatorOptions {
-//   listOf?: false;
-// }
-// interface ValidatorOptionsForList extends ValidatorOptions {
-//   listOf: true;
-// }
-// type ValidatorOptionsUnion = ValidatorOptionsForValue | ValidatorOptionsForList
+export interface ValidatorOptions {
+  maxLength?: number;
+  minLength?: number; 
+  shouldTruncate?: boolean; 
+  toLower?: boolean;
+  isOptional?: boolean; 
+  emptyStringOk?: boolean; 
+  emptyListOk?: boolean; 
+  nullOk?: boolean;
+  isObject?: boolean; 
+  isNumber?: boolean; 
+  listOf?: boolean; 
+  isBoolean?: boolean;
+  errorMessage?: string;
+  trim?: boolean;
+}  
+export interface ValidatorOptionsForValue extends ValidatorOptions {
+  listOf?: false;
+}
+export interface ValidatorOptionsForList extends ValidatorOptions {
+  listOf: true;
+}
+export type ValidatorOptionsUnion = ValidatorOptionsForValue | ValidatorOptionsForList
 
-// export type EscapeBuilder <R=any> = {
-//   (o?: ValidatorOptionsForValue): EscapeFunction<R>;
-//   (o?: ValidatorOptionsForList):  EscapeFunction<R[]>;
-// }
-// type ComplexEscapeBuilder <C,R=any> = (customization: C) => EscapeBuilder<R>
+export type EscapeWithOptions<R=any> = (o: ValidatorOptions) => (v: JSONType) => R
+export type EscapeFunction<R=any> = (v: JSONType) => R
+export type EscapeToList<R=any> = EscapeFunction<R[]>
 
-// type InputValues <T> = { [K in keyof T]: JSONType }
-// export type InputValidation<T> = { [K in keyof T]: EscapeFunction }
+export type EscapeBuilder <R=any> = {
+  (o?: ValidatorOptionsForValue): EscapeFunction<R>;
+  (o?: ValidatorOptionsForList):  EscapeFunction<R[]>;
+}
+export type ComplexEscapeBuilder <C,R=any> = (customization: C) => EscapeBuilder<R>
+
+export type InputValues <T> = { [K in keyof T]: JSONType }
+export type InputValidation<T> = { [K in keyof T]: EscapeFunction }
 
+export const MAX_FILE_SIZE = 25000000 // 25 megabytes in bytes
 const DEFAULT_MAX_LENGTH = 5000
 type BuildValidator_T = {
   (escapeFunction: EscapeFunction, options: ValidatorOptionsForList): EscapeToList;
@@ -185,9 +208,9 @@ export const objectValidator = <T extends object>(i: InputValidation<Required<T>
     for (const field in i) {
       const value = (object as Indexable)[field] 
       const escaped = i[field](value) // may be required
-      if (escaped) { // omit undefined, optional arguments
-        validated[field] = escaped
-      }
+      if (escaped === undefined) continue
+
+      validated[field] = escaped
     }
 
     return validated
@@ -249,6 +272,7 @@ export const listValidator = <T>(b: EscapeFunction<T>): EscapeBuilder<T[]> => o
 )
 
 export const listOfStringsValidator = listValidator(stringValidator()) 
+export const listOfObjectAnyFieldsValidator = listValidator(objectAnyFieldsValidator())
 
 export const booleanValidator: EscapeBuilder<boolean> = (options={}) => build_validator(
   boolean => {
@@ -332,6 +356,7 @@ export const numberValidatorBuilder: ComplexEscapeBuilder<{ lower: number, upper
 
 export const nonNegNumberValidator = numberValidatorBuilder({ lower: 0, upper: 100000000 })
 export const numberValidator = numberValidatorBuilder({ lower: -100000000, upper: 100000000 })
+export const fileSizeValidator = numberValidatorBuilder({ lower: 0, upper: MAX_FILE_SIZE })
 
 export const dateValidator: EscapeBuilder<Date> = (options={}) => build_validator(
   (date: any) => {
@@ -390,6 +415,16 @@ export const phoneValidator: EscapeBuilder<string> = (options={}) => build_valid
   { ...options, maxLength: 25, listOf: false }
 )
 
+export const fileTypeValidator: EscapeBuilder<string> = (options={}) => build_validator(
+  (s: any) => {
+    if (typeof s !== 'string') throw new Error("fileType must be a string")
+    if (!isMimeType(s)) throw new Error(`${s} is not a valid file type`)
+
+    return s
+  }, 
+  { ...options, listOf: false }
+)
+
 export const safeBase64Validator = (options={}) => build_validator(
   (sb64: any) => {
     if (typeof sb64 !== 'string') throw new Error("Expecting string")
@@ -629,8 +664,57 @@ const _MESSAGE_TEMPLATE_TYPES: { [K in MessageTemplateType]: any } = {
 export const MESSAGE_TEMPLATE_TYPES = Object.keys(_MESSAGE_TEMPLATE_TYPES) as MessageTemplateType[]
 export const messageTemplateTypeValidator = exactMatchValidator<MessageTemplateType>(MESSAGE_TEMPLATE_TYPES)
 
+const _MEETING_STATUSES: { [K in MeetingStatus]: any } = {
+  ended: '',
+  live: '',
+  scheduled: '',
+}
+export const MEETING_STATUSES = Object.keys(_MEETING_STATUSES) as MeetingStatus[]
+export const meetingStatusValidator = exactMatchValidator<MeetingStatus>(MEETING_STATUSES)
+
+export const sessionTypeValidator = exactMatchValidator<SessionType>(['user', 'enduser'])
+
 export const listOfDisplayNameInfo = listValidator(objectValidator<{ fname: string, lname: string, id: string }>({ 
   fname: nameValidator(), 
   lname: nameValidator(),
   id: listOfMongoIdStringValidator(),
+})())
+
+export const attendeeInfoValidator = objectValidator<AttendeeInfo>({
+  AttendeeId: stringValidator(),
+  ExternalUserId: mongoIdStringValidator(),
+  JoinToken: stringValidator(),
+})
+
+export const attendeeValidator = objectValidator<{
+  type: SessionType,
+  id: string,
+  info: { Attendee: AttendeeInfo },
+}>({ 
+  type: sessionTypeValidator(),
+  id: mongoIdStringValidator(),
+  info: attendeeInfoValidator(),
+}) 
+export const listOfAttendeesValidator = listValidator(attendeeValidator())
+export const meetingInfoValidator = objectValidator<{ Meeting: MeetingInfo }>({ 
+  Meeting: objectAnyFieldsValidator(),
+}) 
+
+export const userIdentityValidator = objectValidator<{
+  type: SessionType,
+  id: string,
+}>({ 
+  type: sessionTypeValidator(),
+  id: mongoIdStringValidator(),
+}) 
+export const listOfUserIndentitiesValidator = listValidator(userIdentityValidator())
+
+export const meetingsListValidator = listValidator(objectValidator<{
+  id: string,
+  updatedAt: string,
+  status: MeetingStatus,
+}>({
+  id: mongoIdStringValidator(),
+  updatedAt: stringValidator(),
+  status: meetingStatusValidator(),
 })())

package/tsconfig.json

@@ -7,8 +7,9 @@
   "exclude": ["node_modules", "lib"],
   "include": ["src"],
   "references": [
-    { "path": "../types" },
     { "path": "../constants" },
+    { "path": "../types-utilities" },
+    { "path": "../types-models" },
     { "path": "../utilities" }
   ]
 }